-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
added documentation for the text-decoration-control component #57184
added documentation for the text-decoration-control component #57184
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the continued efforts to improve documentation @BenjaminZekavica 👍
TextDecorationControl
and TextTransformControl
(readme added in #52243) are actually experimental components. I was under the impression these shouldn't have documentation until they are stabilized.
An alternative to waiting on that stabilization might be to flag the components as experimental in the readme docs similar to how it is done in the @wordpress/components
package by prefixing the following.
<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>
<br />
This also highlights an error in the usage information as the import statement is incorrect.
I've left a few other tweaks as inline suggestions.
packages/block-editor/src/components/text-decoration-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/text-decoration-control/README.md
Outdated
Show resolved
Hide resolved
@aaronrobertshaw Thank you :) I updated the readme, do you can check it please? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for continuing to iterate on this @BenjaminZekavica 🙇
I think this PR is nearly ready. I've left a couple of further tweaks as inline suggestions we should probably address before merging.
packages/block-editor/src/components/text-decoration-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/text-decoration-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/text-decoration-control/README.md
Outdated
Show resolved
Hide resolved
…EADME.md Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
…EADME.md Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
…EADME.md Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
@aaronrobertshaw I accepted your changes now :) I think it's ready to merge 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚢
It appears there's a failing e2e due to a timeout. I've hit re-run on that job. Once everything passes we can look to merge. |
What?
Added documentation for the text-decoration control.
Why?
#52071