-
Notifications
You must be signed in to change notification settings - Fork 881
Make rule descriptions more consistent #4385
Copy link
Copy link
Closed
Labels
docsDocumentation changesDocumentation changesrule metadataIssues in the rule metadata code (lib/rules)Issues in the rule metadata code (lib/rules)
Milestone
Description
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docsDocumentation changesDocumentation changesrule metadataIssues in the rule metadata code (lib/rules)Issues in the rule metadata code (lib/rules)