From 90a01800407c0005e755c92be35745de327f173b Mon Sep 17 00:00:00 2001 From: Ankit Kumar Shah Date: Tue, 24 Dec 2024 10:15:02 +0530 Subject: [PATCH] Docs: Improve BlockCard component JSDoc documentation --- packages/block-editor/src/components/block-card/index.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/block-editor/src/components/block-card/index.js b/packages/block-editor/src/components/block-card/index.js index 0ce60fc88c8bb0..0d0713a9f0b7bb 100644 --- a/packages/block-editor/src/components/block-card/index.js +++ b/packages/block-editor/src/components/block-card/index.js @@ -49,12 +49,12 @@ const { Badge } = unlock( componentsPrivateApis ); * * @param {Object} props Component props. * @param {string} props.title The title of the block. - * @param {string|Object} props.icon Block icon component or string identifier. - * @param {string} props.description Optional description of the block. + * @param {string|Object} props.icon The icon of the block. This can be any of[WordPress Dashicons](https://developer.wordpress.org/resource/dashicons/), or a custom `svg` element. + * @param {string} props.description The description of the block. * @param {Object} [props.blockType] Deprecated: Object containing block type data. * @param {string} [props.className] Additional classes to apply to the card. * @param {string} [props.name] Custom block name to display before the title. - * @return {Element} Block card component. + * @return {Element} Block card component. */ function BlockCard( { title, icon, description, blockType, className, name } ) { if ( blockType ) {