gutenberg icon indicating copy to clipboard operation
gutenberg copied to clipboard

Fix block description In-consistency

Open Infinite-Null opened this issue 9 months ago • 3 comments

Closes: #69475

What?

This PR standardizes block descriptions in the /packages/block-library directory, ensuring verb tense and structure consistency.

Why?

Some descriptions use different verb tenses (e.g., “Display” vs. “Displays”). This PR aims to standardize descriptions using a third-person verb format where applicable.

How?

  • Updated descriptions that start with a verb to use third-person singular (e.g., “Displays” instead of “Display”).
  • Ensured consistency across all block descriptions in the block library.

Testing Instructions

  1. Search for the description in block.json in /packages/block-library.
  2. Also you can open the block editor and inspect block descriptions in the block settings panel.
  3. Compare the description changes to ensure consistency.

Infinite-Null avatar Mar 06 '25 16:03 Infinite-Null

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @aditya-raj-panjiyara.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: aditya-raj-panjiyara.

Co-authored-by: Infinite-Null <[email protected]>
Co-authored-by: cobianzo <[email protected]>
Co-authored-by: talldan <[email protected]>
Co-authored-by: hanneslsm <[email protected]>
Co-authored-by: afercia <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions[bot] avatar Mar 12 '25 06:03 github-actions[bot]

Hi @afercia, I have made the block description consistent please review it at your convenience. Thank You!

Infinite-Null avatar Mar 12 '25 07:03 Infinite-Null

Hi @Infinite-Null , cc @afercia As you can see, I have spotted some more files that need updates after the texts changes ( documentation files and e2e test files) . I wonder how the Playwright tests didn't flag an error about it.

I also have one question, shouldnt' the text "Start with the basic building block of all narrative.", be updated into "Starts with the basic building block of all narrative.",?

Also, I'd like to flag @talldan comment on https://github.com/WordPress/gutenberg/pull/70430#issuecomment-2975369618 , asking for some more discussion on the issue itself.

cobianzo avatar Jun 17 '25 00:06 cobianzo

Hi @Infinite-Null , I am not sure if this PR is still active. Just in case, I had a look to it, and I found an incongruence in the changes: The text:
Start with the basic building block of all narrative still exists in the codebase, either as descriptions in md files and in the block.json for paragraph. That is why the e2e spec fails.

I suggest to make a Ctrl+Shift+F and find all 'Start with the basic building block of all narrative', and replace it by Starts with the basic building block of all narrative

I believe that's the only thing missed in the PR.

cobianzo avatar Jul 10 '25 23:07 cobianzo