-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Open
Labels
Needs Copy ReviewNeeds review of user-facing copy (language, phrasing)Needs review of user-facing copy (language, phrasing)Needs Design FeedbackNeeds general design feedback.Needs general design feedback.[Package] Block library/packages/block-library/packages/block-library[Status] In ProgressTracking issues with work in progressTracking issues with work in progress[Type] BugAn existing feature does not function as intendedAn existing feature does not function as intended[Type] CopyIssues or PRs that need copy editing assistanceIssues or PRs that need copy editing assistance
Description
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:
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
Displayvs.Displayscase. - I'd suggest to also use third person for all the descriptions that start with a verb.
-To be discussed: whether other patterns likeThe author name.orA 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-librarydirectory. - 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
Infinite-Null
Metadata
Metadata
Assignees
Labels
Needs Copy ReviewNeeds review of user-facing copy (language, phrasing)Needs review of user-facing copy (language, phrasing)Needs Design FeedbackNeeds general design feedback.Needs general design feedback.[Package] Block library/packages/block-library/packages/block-library[Status] In ProgressTracking issues with work in progressTracking issues with work in progress[Type] BugAn existing feature does not function as intendedAn existing feature does not function as intended[Type] CopyIssues or PRs that need copy editing assistanceIssues or PRs that need copy editing assistance
