Skip to content

Commit ed80299

Browse files
authored
Interface: Add missing param docs for singleEnableItems() and multipleEnableItems() (WordPress#22964)
1 parent a9d2c1f commit ed80299

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

packages/interface/src/store/reducer.js

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ import { combineReducers } from '@wordpress/data';
1111
/**
1212
* Reducer to keep tract of the active area per scope.
1313
*
14-
* @param {boolean} state Previous state.
15-
* @param {Object} action Action Object.
14+
* @param {boolean} state Previous state.
15+
* @param {Object} action Action object.
16+
* @param {string} action.type Action type.
17+
* @param {string} action.itemType Type of item.
18+
* @param {string} action.scope Item scope.
19+
* @param {string} action.item Item name.
1620
*
1721
* @return {Object} Updated state.
1822
*/
@@ -34,10 +38,15 @@ export function singleEnableItems(
3438
}
3539

3640
/**
37-
* Reducer keeping track of the "pinned" items per scope
41+
* Reducer keeping track of the "pinned" items per scope.
3842
*
39-
* @param {boolean} state Previous state.
40-
* @param {Object} action Action Object.
43+
* @param {boolean} state Previous state.
44+
* @param {Object} action Action object.
45+
* @param {string} action.type Action type.
46+
* @param {string} action.itemType Type of item.
47+
* @param {string} action.scope Item scope.
48+
* @param {string} action.item Item name.
49+
* @param {boolean} action.isEnable Whether the item is pinned.
4150
*
4251
* @return {Object} Updated state.
4352
*/

0 commit comments

Comments
 (0)