From 33c730f276c646764378743cb8f61fddaf292f45 Mon Sep 17 00:00:00 2001 From: Andrea Fercia Date: Fri, 18 Oct 2024 11:33:17 +0200 Subject: [PATCH] Minor adjustments for the docblock. --- .../components/post-featured-image/index.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/editor/src/components/post-featured-image/index.js b/packages/editor/src/components/post-featured-image/index.js index afdd82b586115..cabd791e938bf 100644 --- a/packages/editor/src/components/post-featured-image/index.js +++ b/packages/editor/src/components/post-featured-image/index.js @@ -122,16 +122,16 @@ function PostFeaturedImage( { } /** - * Get image Alt text. + * Generates the featured image alt text for this editing context. * - * @param {Object} imageMedia - The image media object. - * @param {string} imageMedia.alt_text - The alternative text of the image. - * @param {Object} imageMedia.media_details - The media details of the image. - * @param {Object} imageMedia.media_details.sizes - The sizes of the image. - * @param {Object} imageMedia.media_details.sizes.full - The full size details of the image. - * @param {string} imageMedia.media_details.sizes.full.file - The file name of the full size image. - * @param {string} imageMedia.slug - The slug of the image. - * @return {string} The description of the image. + * @param {Object} imageMedia The image media object. + * @param {string} imageMedia.alt_text The alternative text of the image. + * @param {Object} imageMedia.media_details The media details of the image. + * @param {Object} imageMedia.media_details.sizes The sizes of the image. + * @param {Object} imageMedia.media_details.sizes.full The full size details of the image. + * @param {string} imageMedia.media_details.sizes.full.file The file name of the full size image. + * @param {string} imageMedia.slug The slug of the image. + * @return {string} The featured image alt text. */ function getImageDescription( imageMedia ) { if ( imageMedia.alt_text ) {