Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blocks descriptions use inconsistent verb person and pattern #69475

Open
2 of 6 tasks
afercia opened this issue Mar 6, 2025 · 0 comments · May be fixed by #69478
Open
2 of 6 tasks

Blocks descriptions use inconsistent verb person and pattern #69475

afercia opened this issue Mar 6, 2025 · 0 comments · May be fixed by #69478
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Package] Block library /packages/block-library [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended [Type] Copy Issues or PRs that need copy editing assistance

Comments

@afercia
Copy link
Contributor

afercia commented Mar 6, 2025

Description

All the blocks come with their own name and description.
One of the main places where the description is shown in the UI is in the 'block card' at the top of the Block settings panel.

Many of these description use an inconsistent verb person, the most evident is Display vs. Displays (third person).

There's many other verbs in use with the same inconsistency. Other descriptions use a completely different pattern. A few screenshots:

Image

While minor, this introduces inconsistency and unnecessary cognitive load with understanding the difference between the different wordings.

At the very least I'd suggest to:

  • Fix the most evident Display vs. Displays case.
  • I'd suggest to also use third person for all the descriptions that start with a verb.
    -To be discussed: whether other patterns like The author name. or A calendar of your site’s posts. should be changed to use a sentence that starts with a verb.

Some of the other starting verbs I found:

  • Add
  • Contains
  • Create
  • Describe
  • Embed
  • Gather
  • Give
  • Hide and show
  • Insert
  • Introduce
  • Prompt
  • Provide
  • Reuse
  • Separate
  • Set
  • Show
  • Summarize
  • Use

Other patterns examples:

  • The author name.
  • A calendar of your site’s posts.

Step-by-step reproduction instructions

  • Search in the codebase for "description" (including the quotes) limiting the search to the /packages/block-library directory.
  • Observe the inconsistencies in the descriptions.

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

  • Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

  • Yes

Please confirm which theme type you used for testing.

  • Block
  • Classic
  • Hybrid (e.g. classic with theme.json)
  • Not sure
@afercia afercia added [Package] Block library /packages/block-library [Type] Bug An existing feature does not function as intended [Type] Copy Issues or PRs that need copy editing assistance Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Mar 6, 2025
@Infinite-Null Infinite-Null linked a pull request Mar 6, 2025 that will close this issue
@github-actions github-actions bot added the [Status] In Progress Tracking issues with work in progress label Mar 6, 2025
@afercia afercia changed the title Blocks description use inconsistent verb person and pattern Blocks descriptions use inconsistent verb person and pattern Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Package] Block library /packages/block-library [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended [Type] Copy Issues or PRs that need copy editing assistance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant