Accordion: Update block descriptions #72602
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mikachan
requested review from
ajitbohra,
fabiankaegy and
juanmaguitar
as code owners
mikachan
added
[Type] Bug
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
jasmussen
reviewed
Oct 23, 2025
jasmussen
reviewed
Oct 23, 2025
docs/reference-guides/core-blocks.md
Outdated
| ## Accordion Heading | ||
|
|
||
| Displays an accordion heading. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/accordion-heading)) | ||
| Displays a clickable heading that toggles the content panel open and closed. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/accordion-heading)) |
Contributor
There was a problem hiding this comment.
I wonder if there's a term other than "clickable", especially since the "toggles" term shows up later. Perhaps something simple:
Toggles the accordion panel.
A bit bare, perhaps, but simple and maybe reads well.
Contributor
|
Thanks for the PR. A good baseline here:
There's still something duplicative with these, and they all start with "Displays ...". I wonder if we can simplify a bit. Some brainstorming:
|
Member
Author
|
Thanks for taking a look, @jasmussen 🙇
The reason I kept this part was that it had been discussed previously to be more consistent with the starting verb in block descriptions, and "displays" seems to be favoured:
However, I'm not sure if we always have to use "displays", and combining this with your suggestions still works better, I think. Something like this, perhaps:
|
Contributor
|
Go for it! |
jasmussen
approved these changes
Oct 23, 2025
mikachan
force-pushed
the
update/accordion-block-descriptions
branch
from
4889160 to
8539fa0
Compare
|
Size Change: +26 B (0%) Total Size: 2.37 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 785ac2e. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/18844374511
|
mikachan
added
the
Backport to WP 6.9 Beta/RC
github-actions
bot
removed
the
Backport to WP 6.9 Beta/RC
gutenbergplugin
pushed a commit
that referenced
this pull request
Oct 27, 2025
* Update block descriptions * Update descriptions based on feedback * Attempt to fix test Co-authored-by: mikachan <[email protected]> Co-authored-by: jasmussen <[email protected]>
github-actions
bot
added
the
Backported to WP Core
|
I just cherry-picked this PR to the wp/6.9 branch to get it included in the next release: db8510f |
tyxla
reviewed
Oct 29, 2025
| ## Accordion Heading | ||
|
|
||
| Displays an accordion heading. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/accordion-heading)) | ||
| Toggles the accordion panel. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/accordion-heading)) |
Member
There was a problem hiding this comment.
The toggle also displays a heading though, should we have kept a hint for that?
Contributor
There was a problem hiding this comment.
If it's meaningful to understand as part of the block description. My opinion was that it isn't, but that's not a strong opinion.
Member
There was a problem hiding this comment.
I don't have a strong opinion either, but I think it's better if we clearly convey that it also renders the heading.
Member
Author
There was a problem hiding this comment.
I don't have a strong opinion either, but this block does display a heading, so perhaps it's best to mention it in the description. I'll open a quick PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
The Accordion block descriptions are currently quite duplicative (with the word "accordion") and could be more descriptive, so this updates each Accordion block description with some wording improvements.
Why?
Improves the readability of these block descriptions.
How?
Updates block descriptions.
Testing Instructions
There are no changes to functionality.
Screenshots or screencast