From ed8029923fc9bc83f2cdfedca60225188aae9f17 Mon Sep 17 00:00:00 2001 From: Dominik Schilling Date: Sat, 6 Jun 2020 13:45:29 +0200 Subject: [PATCH] Interface: Add missing param docs for singleEnableItems() and multipleEnableItems() (#22964) --- packages/interface/src/store/reducer.js | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/packages/interface/src/store/reducer.js b/packages/interface/src/store/reducer.js index b39c083b7b9607..cffcee68a9070d 100644 --- a/packages/interface/src/store/reducer.js +++ b/packages/interface/src/store/reducer.js @@ -11,8 +11,12 @@ import { combineReducers } from '@wordpress/data'; /** * Reducer to keep tract of the active area per scope. * - * @param {boolean} state Previous state. - * @param {Object} action Action Object. + * @param {boolean} state Previous state. + * @param {Object} action Action object. + * @param {string} action.type Action type. + * @param {string} action.itemType Type of item. + * @param {string} action.scope Item scope. + * @param {string} action.item Item name. * * @return {Object} Updated state. */ @@ -34,10 +38,15 @@ export function singleEnableItems( } /** - * Reducer keeping track of the "pinned" items per scope + * Reducer keeping track of the "pinned" items per scope. * - * @param {boolean} state Previous state. - * @param {Object} action Action Object. + * @param {boolean} state Previous state. + * @param {Object} action Action object. + * @param {string} action.type Action type. + * @param {string} action.itemType Type of item. + * @param {string} action.scope Item scope. + * @param {string} action.item Item name. + * @param {boolean} action.isEnable Whether the item is pinned. * * @return {Object} Updated state. */