Skip to content

Make rule descriptions more consistent #4385

@sknep

Description

@sknep

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation changesrule metadataIssues in the rule metadata code (lib/rules)

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions