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

Improve the base control help prop documentation. #63693

Merged
merged 2 commits into from
Jul 22, 2024

Conversation

afercia
Copy link
Contributor

@afercia afercia commented Jul 18, 2024

Fixes #63692

What?

The base control help prop documentation can be improved to clarify contributors must use it only for meaningful description or instructions for the related control.

Why?

To prevent incorrect usage of this prop.

How?

Adds to the doc the sentence Only use for meaningful description or instructions for the control.

Testing Instructions

N/A

Testing Instructions for Keyboard

Screenshots or screencast

@afercia afercia added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Jul 18, 2024
@afercia afercia requested a review from ajitbohra as a code owner July 18, 2024 08:48
Copy link

github-actions bot commented Jul 18, 2024

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.

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

Co-authored-by: afercia <afercia@git.wordpress.org>
Co-authored-by: tyxla <tyxla@git.wordpress.org>

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

@afercia afercia requested review from mirka, ciampo and tyxla July 19, 2024 09:47
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks @afercia 🚀

@afercia afercia merged commit d0b82da into trunk Jul 22, 2024
65 checks passed
@afercia afercia deleted the update/base-control-help-prop-docs branch July 22, 2024 06:45
@github-actions github-actions bot added this to the Gutenberg 18.9 milestone Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the inputs help prop documentation
2 participants