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

Editorial: clarify expectations for name/desc verbosity #1650

Merged
merged 3 commits into from
Dec 6, 2021
Merged

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Nov 24, 2021

closes #1649

These editorial changes attempt to clarify that a description doesn't have to be verbose.

It also adjusts some wording so when talking about an accessible name, the spec is saying that, and not using the term "label"

This update touches aria-labelledby and aria-describedby - because they share the same paragraph between the two. It also touches aria-description which also was semi-reusing the paragraph that was repeated between aria-labelledby and aria-describedby - but it also needed a few wording changes.

Happy for others to add onto this or make further wording adjustments as need be.


Preview | Diff

closes #1649 

These editorial changes attempt to clarify that a description _doesn't have to be verbose_.

It also adjusts some wording so when talking about an accessible name, the spec is saying that, and not using the term "label"

This update touches `aria-labelledby` and `aria-describedby` - because they share the same paragraph between the two.  It also touches `aria-description` which also was semi-reusing the paragraph that was repeated between `aria-labelledby` and `aria-describedby` - but it also needed a few wording changes.


Happy for others to add onto this or make further wording adjustments as need be.
Copy link
Member Author

@scottaohara scottaohara left a comment

Choose a reason for hiding this comment

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

edit to keep paragraphs in sync and fix a typo

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@jnurthen jnurthen requested a review from pkra December 2, 2021 18:19
@pkra pkra self-assigned this Dec 3, 2021
@pkra pkra added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Dec 3, 2021
@pkra pkra merged commit 431b017 into main Dec 6, 2021
github-actions bot added a commit that referenced this pull request Dec 6, 2021
SHA: 431b017
Reason: push, by @pkra

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@pkra
Copy link
Member

pkra commented Dec 6, 2021

@jnurthen @michael-n-cooper What is the process to update the stable branch? Do I simply cherry pick the merged commit and push it to stable?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo merge conflict with stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aria-describedby, verbose vs. concise and arbitrary 'state' information
3 participants