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.

Sign up for GitHub

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

Jump to bottom

Make rule descriptions more consistent #4385

Closed
sknep opened this issue Mar 26, 2024 · 1 comment · Fixed by #4527
Closed

Make rule descriptions more consistent #4385

sknep opened this issue Mar 26, 2024 · 1 comment · Fixed by #4527
Labels
docs Documentation changes rule metadata Issues in the rule metadata code (lib/rules)
Milestone
Axe-core 4.10

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
@marktnoonan marktnoonan mentioned this issue Jun 11, 2024
Merged
WilcoFiers pushed a commit that referenced this issue Jun 17, 2024
@marktnoonan
fix: correct typos in texts (#4499)
11fad59 
Hi! I noticed some minor typos and inconsistent text capitalization, as
well as what looks like flipped `help` and `description` text in one
spot for the `landmark-unique` rule. This PR fixes the ones I was able
to spot.

I noticed some overlap with
#4385, I'd be happy to grab
the text changes mentioned there in this PR as well, ("Ensures" ->
"Ensure" in rule descriptions), if that's not stepping on anybody's
toes.
@marktnoonan marktnoonan mentioned this issue Jul 5, 2024
Merged
straker pushed a commit that referenced this issue Jul 8, 2024
@marktnoonan
chore(text): standardize rule descriptions (#4527)
be406d4 
Currently, English-language rule descriptions begin with either `Ensure`
or `Ensures`. This PR standardizes the descriptions to the imperative
`Ensure`, as described here:
#4385

Closes: #4385
koralle added a commit to koralle/vitest-axe that referenced this issue Jul 30, 2024
@koralle
test: update expected messages
9dbd65f 
Rule descriptions have been changed in:
  dequelabs/axe-core#4385
koralle added a commit to koralle/vitest-axe that referenced this issue Aug 18, 2024
@koralle
test: update expected messages
05701aa 
Rule descriptions have been changed in:
  dequelabs/axe-core#4385
koralle added a commit to koralle/vitest-axe that referenced this issue Aug 18, 2024
@koralle
test: update expected messages
4046424 
Rule descriptions have been changed in:
  dequelabs/axe-core#4385
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation changes rule metadata Issues in the rule metadata code (lib/rules)
Projects
None yet
Milestone
Axe-core 4.10
Development

Successfully merging a pull request may close this issue.

chore(text): standardize rule descriptions marktnoonan/axe-core
3 participants
@WilcoFiers @straker @sknep