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

docs: minor corrections to rule help/description text #4685

Merged
merged 3 commits into from
Mar 25, 2025
+8 −8
Merged

docs: minor corrections to rule help/description text #4685

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9aa01d0
fix(hidden-content): Make the description text consistent with others…
ma10 Jan 30, 2025
a02345d
fix(presentation-role-conflict): swap the content of the help and the…
ma10 Jan 30, 2025
00dcb09
chore: reflect the changes to the generated files.
ma10 Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/rule-descriptions.md
View file
Original file line number Diff line number Diff line change
@@ -119,7 +119,7 @@ Rules that do not necessarily conform to WCAG success criterion but are industry
| [landmark-unique](https://dequeuniversity.com/rules/axe/4.10/landmark-unique?application=RuleDescription) | Ensure landmarks are unique | Moderate | cat.semantics, best-practice | failure | |
| [meta-viewport-large](https://dequeuniversity.com/rules/axe/4.10/meta-viewport-large?application=RuleDescription) | Ensure <meta name="viewport"> can scale a significant amount | Minor | cat.sensory-and-visual-cues, best-practice | failure | |
| [page-has-heading-one](https://dequeuniversity.com/rules/axe/4.10/page-has-heading-one?application=RuleDescription) | Ensure that the page, or at least one of its frames contains a level-one heading | Moderate | cat.semantics, best-practice | failure | |
| [presentation-role-conflict](https://dequeuniversity.com/rules/axe/4.10/presentation-role-conflict?application=RuleDescription) | Elements marked as presentational should not have global ARIA or tabindex to ensure all screen readers ignore them | Minor | cat.aria, best-practice, ACT | failure | [46ca7f](https://act-rules.github.io/rules/46ca7f) |
| [presentation-role-conflict](https://dequeuniversity.com/rules/axe/4.10/presentation-role-conflict?application=RuleDescription) | Ensure elements marked as presentational are consistently ignored | Minor | cat.aria, best-practice, ACT | failure | [46ca7f](https://act-rules.github.io/rules/46ca7f) |
| [region](https://dequeuniversity.com/rules/axe/4.10/region?application=RuleDescription) | Ensure all page content is contained by landmarks | Moderate | cat.keyboard, best-practice | failure | |
| [scope-attr-valid](https://dequeuniversity.com/rules/axe/4.10/scope-attr-valid?application=RuleDescription) | Ensure the scope attribute is used correctly on tables | Moderate | cat.tables, best-practice | failure | |
| [skip-link](https://dequeuniversity.com/rules/axe/4.10/skip-link?application=RuleDescription) | Ensure all skip links have a focusable target | Moderate | cat.keyboard, best-practice | failure, needs review | |
@@ -144,7 +144,7 @@ Rules we are still testing and developing. They are disabled by default in axe-c
| :-------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ | :------- | :----------------------------------------------------------------------------------------------------------- | :------------------------- | :------------------------------------------------------------------ |
| [css-orientation-lock](https://dequeuniversity.com/rules/axe/4.10/css-orientation-lock?application=RuleDescription) | Ensure content is not locked to any specific display orientation, and the content is operable in all display orientations | Serious | cat.structure, wcag134, wcag21aa, EN-301-549, EN-9.1.3.4, experimental | failure, needs review | [b33eff](https://act-rules.github.io/rules/b33eff) |
| [focus-order-semantics](https://dequeuniversity.com/rules/axe/4.10/focus-order-semantics?application=RuleDescription) | Ensure elements in the focus order have a role appropriate for interactive content | Minor | cat.keyboard, best-practice, experimental | failure | |
| [hidden-content](https://dequeuniversity.com/rules/axe/4.10/hidden-content?application=RuleDescription) | Informs users about hidden content. | Minor | cat.structure, best-practice, experimental, review-item | failure, needs review | |
| [hidden-content](https://dequeuniversity.com/rules/axe/4.10/hidden-content?application=RuleDescription) | Inform users about hidden content. | Minor | cat.structure, best-practice, experimental, review-item | failure, needs review | |
| [label-content-name-mismatch](https://dequeuniversity.com/rules/axe/4.10/label-content-name-mismatch?application=RuleDescription) | Ensure that elements labelled through their content must have their visible text as part of their accessible name | Serious | cat.semantics, wcag21a, wcag253, EN-301-549, EN-9.2.5.3, experimental | failure | [2ee8b8](https://act-rules.github.io/rules/2ee8b8) |
| [p-as-heading](https://dequeuniversity.com/rules/axe/4.10/p-as-heading?application=RuleDescription) | Ensure bold, italic text and font-size is not used to style <p> elements as a heading | Serious | cat.semantics, wcag2a, wcag131, EN-301-549, EN-9.1.3.1, experimental | failure, needs review | |
| [table-fake-caption](https://dequeuniversity.com/rules/axe/4.10/table-fake-caption?application=RuleDescription) | Ensure that tables with a caption use the <caption> element. | Serious | cat.tables, experimental, wcag2a, wcag131, section508, section508.22.g, EN-301-549, EN-9.1.3.1 | failure | |
2 changes: 1 addition & 1 deletion lib/rules/hidden-content.json
View file
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
"excludeHidden": false,
"tags": ["cat.structure", "best-practice", "experimental", "review-item"],
"metadata": {
"description": "Informs users about hidden content.",
"description": "Inform users about hidden content.",
"help": "Hidden content on the page should be analyzed"
},
"all": [],
4 changes: 2 additions & 2 deletions lib/rules/presentation-role-conflict.json
View file
Original file line number Diff line number Diff line change
@@ -6,8 +6,8 @@
"tags": ["cat.aria", "best-practice", "ACT"],
"actIds": ["46ca7f"],
"metadata": {
"description": "Elements marked as presentational should not have global ARIA or tabindex to ensure all screen readers ignore them",
"help": "Ensure elements marked as presentational are consistently ignored"
"description": "Ensure elements marked as presentational are consistently ignored",
"help": "Elements marked as presentational should not have global ARIA or tabindex to ensure all screen readers ignore them"
},
"all": [],
"any": [],
6 changes: 3 additions & 3 deletions locales/_template.json
View file
Original file line number Diff line number Diff line change
@@ -202,7 +202,7 @@
"help": "Heading levels should only increase by one"
},
"hidden-content": {
"description": "Informs users about hidden content.",
"description": "Inform users about hidden content.",
"help": "Hidden content on the page should be analyzed"
},
"html-has-lang": {
@@ -342,8 +342,8 @@
"help": "Page should contain a level-one heading"
},
"presentation-role-conflict": {
"description": "Elements marked as presentational should not have global ARIA or tabindex to ensure all screen readers ignore them",
"help": "Ensure elements marked as presentational are consistently ignored"
"description": "Ensure elements marked as presentational are consistently ignored",
"help": "Elements marked as presentational should not have global ARIA or tabindex to ensure all screen readers ignore them"
},
"region": {
"description": "Ensure all page content is contained by landmarks",