fix: greater consistency of help / description text (#3204)

* fix: greater consistency of help / description text * Apply suggestions from code review Co-authored-by: Steven Lambert <[email protected]> * Update lib/rules/p-as-heading.json Co-authored-by: Glenda Sims <[email protected]> Co-authored-by: Steven Lambert <[email protected]> Co-authored-by: Glenda Sims <[email protected]>
dequelabs · Oct 18, 2021 · 0be12e6 · 0be12e6
1 parent 0ea7e1b
commit 0be12e6
Show file tree

Hide file tree

Showing 17 changed files with 27 additions and 27 deletions.
diff --git a/lib/rules/aria-roledescription.json b/lib/rules/aria-roledescription.json
@@ -4,7 +4,7 @@
   "tags": ["cat.aria", "wcag2a", "wcag412"],
   "metadata": {
     "description": "Ensure aria-roledescription is only used on elements with an implicit or explicit role",
-    "help": "Use aria-roledescription on elements with a semantic role"
+    "help": "aria-roledescription must be on elements with a semantic role"
   },
   "all": [],
   "any": ["aria-roledescription"],

diff --git a/lib/rules/aria-toggle-field-name.json b/lib/rules/aria-toggle-field-name.json
@@ -5,7 +5,7 @@
   "tags": ["cat.aria", "wcag2a", "wcag412", "ACT"],
   "metadata": {
     "description": "Ensures every ARIA toggle field has an accessible name",
-    "help": "ARIA toggle fields have an accessible name"
+    "help": "ARIA toggle fields must have an accessible name"
   },
   "all": [],
   "any": [

diff --git a/lib/rules/css-orientation-lock.json b/lib/rules/css-orientation-lock.json
@@ -5,7 +5,7 @@
   "actIds": ["b33eff"],
   "metadata": {
     "description": "Ensures content is not locked to any specific display orientation, and the content is operable in all display orientations",
-    "help": "CSS Media queries are not used to lock display orientation"
+    "help": "CSS Media queries must not lock display orientation"
   },
   "all": ["css-orientation-lock"],
   "any": [],

diff --git a/lib/rules/focus-order-semantics.json b/lib/rules/focus-order-semantics.json
@@ -4,8 +4,8 @@
   "matches": "inserted-into-focus-order-matches",
   "tags": ["cat.keyboard", "best-practice", "experimental"],
   "metadata": {
-    "description": "Ensures elements in the focus order have an appropriate role",
-    "help": "Elements in the focus order need a role appropriate for interactive content"
+    "description": "Ensures elements in the focus order have a role appropriate for interactive content",
+    "help": "Elements in the focus order should have an appropriate role"
   },
   "all": [],
   "any": ["has-widget-role", "valid-scrollable-semantics"],

diff --git a/lib/rules/hidden-content.json b/lib/rules/hidden-content.json
@@ -5,7 +5,7 @@
   "tags": ["cat.structure", "experimental", "review-item", "best-practice"],
   "metadata": {
     "description": "Informs users about hidden content.",
-    "help": "Hidden content on the page cannot be analyzed"
+    "help": "Hidden content on the page should be analyzed"
   },
   "all": [],
   "any": ["hidden-content"],

diff --git a/lib/rules/identical-links-same-purpose.json b/lib/rules/identical-links-same-purpose.json
@@ -7,7 +7,7 @@
   "actIds": ["b20e66", "fd3a94"],
   "metadata": {
     "description": "Ensure that links with the same accessible name serve a similar purpose",
-    "help": "Links with the same name have a similar purpose"
+    "help": "Links with the same name must have a similar purpose"
   },
   "all": ["identical-links-same-purpose"],
   "any": [],

diff --git a/lib/rules/link-in-text-block.json b/lib/rules/link-in-text-block.json
@@ -5,8 +5,8 @@
   "excludeHidden": false,
   "tags": ["cat.color", "experimental", "wcag2a", "wcag141"],
   "metadata": {
-    "description": "Links can be distinguished without relying on color",
-    "help": "Links must be distinguished from surrounding text in a way that does not rely on color"
+    "description": "Ensure links are distinguished from surrounding text in a way that does not rely on color",
+    "help": "Links must be distinguishable without relying on color"
   },
   "all": ["link-in-text-block"],
   "any": [],

diff --git a/lib/rules/nested-interactive.json b/lib/rules/nested-interactive.json
@@ -4,8 +4,8 @@
   "tags": ["cat.keyboard", "wcag2a", "wcag412"],
   "actIds": ["307n5z"],
   "metadata": {
-    "description": "Nested interactive controls are not announced by screen readers",
-    "help": "Ensure interactive controls are not nested"
+    "description": "Ensure controls are not nested as they are not announced by screen readers",
+    "help": "Interactive controls must not be nested"
   },
   "all": [],
   "any": ["no-focusable-content"],

diff --git a/lib/rules/no-autoplay-audio.json b/lib/rules/no-autoplay-audio.json
@@ -7,7 +7,7 @@
   "actIds": ["80f0bf"],
   "metadata": {
     "description": "Ensures <video> or <audio> elements do not autoplay audio for more than 3 seconds without a control mechanism to stop or mute the audio",
-    "help": "<video> or <audio> elements do not autoplay audio"
+    "help": "<video> or <audio> elements must not play automatically"
   },
   "preload": true,
   "all": ["no-autoplay-audio"],

diff --git a/lib/rules/p-as-heading.json b/lib/rules/p-as-heading.json
@@ -4,8 +4,8 @@
   "matches": "p-as-heading-matches",
   "tags": ["cat.semantics", "wcag2a", "wcag131", "experimental"],
   "metadata": {
-    "description": "Ensure p elements are not used to style headings",
-    "help": "Bold, italic text and font-size are not used to style p elements as a heading"
+    "description": "Ensure bold, italic text and font-size is not used to style <p> elements as a heading",
+    "help": "Styled <p> elements must not be used as headings"
   },
   "all": ["p-as-heading"],
   "any": [],

diff --git a/lib/rules/role-img-alt.json b/lib/rules/role-img-alt.json
@@ -13,7 +13,7 @@
   "actIds": ["23a2a8"],
   "metadata": {
     "description": "Ensures [role='img'] elements have alternate text",
-    "help": "[role='img'] elements have an alternative text"
+    "help": "[role='img'] elements must have an alternative text"
   },
   "all": [],
   "any": ["aria-label", "aria-labelledby", "non-empty-title"],

diff --git a/lib/rules/scrollable-region-focusable.json b/lib/rules/scrollable-region-focusable.json
@@ -4,8 +4,8 @@
   "tags": ["cat.keyboard", "wcag2a", "wcag211"],
   "actIds": ["0ssw9k"],
   "metadata": {
-    "description": "Elements that have scrollable content must be accessible by keyboard",
-    "help": "Ensure that scrollable region has keyboard access"
+    "description": "Ensure elements that have scrollable content are accessible by keyboard",
+    "help": "Scrollable region must have keyboard access"
   },
   "all": [],
   "any": ["focusable-content", "focusable-element"],

diff --git a/lib/rules/svg-img-alt.json b/lib/rules/svg-img-alt.json
@@ -12,8 +12,8 @@
   ],
   "actIds": ["7d6734"],
   "metadata": {
-    "description": "Ensures svg elements with an img, graphics-document or graphics-symbol role have an accessible text",
-    "help": "svg elements with an img role have an alternative text"
+    "description": "Ensures <svg> elements with an img, graphics-document or graphics-symbol role have an accessible text",
+    "help": "<svg> elements with an img role must have an alternative text"
   },
   "all": [],
   "any": [

diff --git a/lib/rules/table-duplicate-name.json b/lib/rules/table-duplicate-name.json
@@ -3,8 +3,8 @@
   "selector": "table",
   "tags": ["cat.tables", "best-practice"],
   "metadata": {
-    "description": "Ensure that tables do not have the same summary and caption",
-    "help": "The <caption> element should not contain the same text as the summary attribute"
+    "description": "Ensure the <caption> element does not contain the same text as the summary attribute",
+    "help": "tables should not have the same summary and caption"
   },
   "all": [],
   "any": [],

diff --git a/lib/rules/td-has-header.json b/lib/rules/td-has-header.json
@@ -11,8 +11,8 @@
     "section508.22.g"
   ],
   "metadata": {
-    "description": "Ensure that each non-empty data cell in a large table has one or more table headers",
-    "help": "All non-empty td element in table larger than 3 by 3 must have an associated table header"
+    "description": "Ensure that each non-empty data cell in a <table> larger than 3 by 3  has one or more table headers",
+    "help": "Non-empty <td> elements in larger <table> must have an associated table header"
   },
   "all": ["td-has-header"],
   "any": [],

diff --git a/lib/rules/td-headers-attr.json b/lib/rules/td-headers-attr.json
@@ -4,8 +4,8 @@
   "tags": ["cat.tables", "wcag2a", "wcag131", "section508", "section508.22.g"],
   "actIds": ["a25f45"],
   "metadata": {
-    "description": "Ensure that each cell in a table using the headers refers to another cell in that table",
-    "help": "All cells in a table element that use the headers attribute must only refer to other cells of that same table"
+    "description": "Ensure that each cell in a table that uses the headers attribute refers only to other cells in that table",
+    "help": "Table cells that use the headers attribute must only refer to cells in the same table"
   },
   "all": ["td-headers-attr"],
   "any": [],

diff --git a/lib/rules/th-has-data-cells.json b/lib/rules/th-has-data-cells.json
@@ -5,8 +5,8 @@
   "tags": ["cat.tables", "wcag2a", "wcag131", "section508", "section508.22.g"],
   "actIds": ["d0f69e"],
   "metadata": {
-    "description": "Ensure that each table header in a data table refers to data cells",
-    "help": "All th elements and elements with role=columnheader/rowheader must have data cells they describe"
+    "description": "Ensure that <th> elements and elements with role=columnheader/rowheader have data cells they describe",
+    "help": "Table headers in a data table must refer to data cells"
   },
   "all": ["th-has-data-cells"],
   "any": [],