From 80f8e34f720edf67c77ce536315212dbb0b97944 Mon Sep 17 00:00:00 2001 From: Riad Benguella Date: Wed, 16 Oct 2019 11:34:25 +0100 Subject: [PATCH] Fix docs --- .../developers/data/data-core-block-editor.md | 4 ++++ packages/block-editor/README.md | 8 +------- .../block-editor/src/components/block-breadcrumb/index.js | 5 +---- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/designers-developers/developers/data/data-core-block-editor.md b/docs/designers-developers/developers/data/data-core-block-editor.md index eb9201165dafd6..11db9dd6608ec9 100644 --- a/docs/designers-developers/developers/data/data-core-block-editor.md +++ b/docs/designers-developers/developers/data/data-core-block-editor.md @@ -189,6 +189,10 @@ _Returns_ - `Array`: Ordered client IDs of editor blocks. +# **getBlockParents** + +Undocumented declaration. + # **getBlockRootClientId** Given a block client ID, returns the root block from which the block is diff --git a/packages/block-editor/README.md b/packages/block-editor/README.md index 7e32a9dfbabe75..6bce65ab5f96f6 100644 --- a/packages/block-editor/README.md +++ b/packages/block-editor/README.md @@ -84,13 +84,7 @@ Undocumented declaration. # **BlockBreadcrumb** -Block breadcrumb component, displaying the label of the block. If the block -descends from a root block, a button is displayed enabling the user to select -the root block. - -_Parameters_ - -- _props.clientId_ `string`: Client ID of block. +Block breadcrumb component, displaying the hierarchy of the current block selection as a breadcrumb. _Returns_ diff --git a/packages/block-editor/src/components/block-breadcrumb/index.js b/packages/block-editor/src/components/block-breadcrumb/index.js index 1f42b0e51eb679..039ffaaece96bd 100644 --- a/packages/block-editor/src/components/block-breadcrumb/index.js +++ b/packages/block-editor/src/components/block-breadcrumb/index.js @@ -11,11 +11,8 @@ import { __ } from '@wordpress/i18n'; import BlockTitle from '../block-title'; /** - * Block breadcrumb component, displaying the label of the block. If the block - * descends from a root block, a button is displayed enabling the user to select - * the root block. + * Block breadcrumb component, displaying the hierarchy of the current block selection as a breadcrumb. * - * @param {string} props.clientId Client ID of block. * @return {WPElement} Block Breadcrumb. */ const BlockBreadcrumb = function() {