Clarify WPBlockSelection docs

WordPress · Nov 22, 2019 · 0a6f065 · 0a6f065
1 parent 3e423f4
commit 0a6f065
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/packages/block-editor/src/store/actions.js b/packages/block-editor/src/store/actions.js
@@ -49,11 +49,14 @@ export function resetBlocks( blocks ) {
 }
 
 /**
- * @typedef {WPBlockSelection} A block selection object.
+ * A block selection object.
+ *
+ * @typedef {Object} WPBlockSelection
  *
  * @property {string} clientId     A block client ID.
  * @property {string} attributeKey A block attribute key.
- * @property {number} offset       A block attribute offset.
+ * @property {number} offset       An attribute value offset, based on the rich
+ *                                 text value. See `wp.richText.create`.
  */
 
 /**

diff --git a/packages/block-editor/src/store/selectors.js b/packages/block-editor/src/store/selectors.js
@@ -37,7 +37,8 @@ import { SVG, Rect, G, Path } from '@wordpress/components';
  *
  * @property {string} clientId     A block client ID.
  * @property {string} attributeKey A block attribute key.
- * @property {number} offset       A block attribute offset.
+ * @property {number} offset       An attribute value offset, based on the rich
+ *                                 text value. See `wp.richText.create`.
  */
 
 // Module constants

diff --git a/packages/editor/src/store/selectors.js b/packages/editor/src/store/selectors.js
@@ -1193,11 +1193,14 @@ export function getEditorBlocks( state ) {
 }
 
 /**
- * @typedef {WPBlockSelection} A block selection object.
+ * A block selection object.
+ *
+ * @typedef {Object} WPBlockSelection
  *
  * @property {string} clientId     A block client ID.
  * @property {string} attributeKey A block attribute key.
- * @property {number} offset       A block attribute offset.
+ * @property {number} offset       An attribute value offset, based on the rich
+ *                                 text value. See `wp.richText.create`.
  */
 
 /**