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

Make rule descriptions more consistent #4385

Open
sknep opened this issue Mar 26, 2024 · 1 comment
Open

Make rule descriptions more consistent #4385

sknep opened this issue Mar 26, 2024 · 1 comment
Labels
docs Documentation changes rule metadata Issues in the rule metadata code (lib/rules)
Milestone

Comments

@sknep
Copy link

sknep commented Mar 26, 2024

Product

axe-core

Description

In the rule description tables at https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md#rule-descriptions , many start with "Ensures...", but some start with "Ensure..." or "Ensure that...".

Is the description field meant to be an explanation of what the rule is for, or what the reader should do to remediate? The second seems more appropriate, but the implied subject of the sentence (rule vs remediation) changes between rules.

Also, "Ensure touch target have sufficient size and space" -- target should be plural, regardless.

@sknep sknep added docs Documentation changes ungroomed Ticket needs a maintainer to prioritize and label labels Mar 26, 2024
@straker
Copy link
Contributor

straker commented Apr 5, 2024

Thanks for the issue. I've brought this up with the team and we've agreed that we'd like to go with "Ensure" for each of the rule descriptions. If you're willing, we'd love a PR fixing all the rule descriptions to be consistent, as well as fixing the target size rule as you've mentioned.

@straker straker added rule metadata Issues in the rule metadata code (lib/rules) and removed ungroomed Ticket needs a maintainer to prioritize and label labels Apr 5, 2024
@straker straker added this to the Axe-core 4.10 milestone Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes rule metadata Issues in the rule metadata code (lib/rules)
Projects
None yet
Development

No branches or pull requests

2 participants