Adding JSDoc for the parents selector

WordPress · Oct 23, 2019 · 78b3925 · 78b3925
1 parent 86ac1e8
commit 78b3925
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docs/designers-developers/developers/data/data-core-block-editor.md b/docs/designers-developers/developers/data/data-core-block-editor.md
@@ -191,7 +191,16 @@ _Returns_
 
 <a name="getBlockParents" href="#getBlockParents">#</a> **getBlockParents**
 
-Undocumented declaration.
+Given a block client ID, returns the list of all its parents.
+
+_Parameters_
+
+-   _state_ `Object`: Editor state.
+-   _clientId_ `string`: Block from which to find root client ID.
+
+_Returns_
+
+-   `Array`: ClientIDs of the parent blocks.
 
 <a name="getBlockRootClientId" href="#getBlockRootClientId">#</a> **getBlockRootClientId**
 

diff --git a/packages/block-editor/src/store/selectors.js b/packages/block-editor/src/store/selectors.js
@@ -418,6 +418,14 @@ export function getBlockRootClientId( state, clientId ) {
 		null;
 }
 
+/**
+ * Given a block client ID, returns the list of all its parents.
+ *
+ * @param {Object} state    Editor state.
+ * @param {string} clientId Block from which to find root client ID.
+ *
+ * @return {Array} ClientIDs of the parent blocks.
+ */
 export const getBlockParents = createSelector(
 	( state, clientId ) => {
 		const parents = [];