From 11fad598c25eadd29f35ef6be382d907057d4537 Mon Sep 17 00:00:00 2001 From: Mark Noonan Date: Mon, 17 Jun 2024 05:35:50 -0400 Subject: [PATCH] fix: correct typos in texts (#4499) 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 https://github.com/dequelabs/axe-core/issues/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. --- doc/rule-descriptions.md | 8 ++--- lib/checks/aria/aria-errormessage.json | 6 ++-- .../forms/autocomplete-appropriate.json | 4 +-- lib/checks/forms/autocomplete-valid.json | 4 +-- lib/checks/shared/aria-labelledby.json | 2 +- lib/checks/shared/presentational-role.json | 2 +- lib/checks/shared/role-none.json | 2 +- lib/checks/shared/role-presentation.json | 2 +- lib/rules/landmark-unique.json | 4 +-- lib/rules/table-duplicate-name.json | 2 +- lib/rules/target-size.json | 2 +- locales/_template.json | 30 +++++++++---------- 12 files changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/rule-descriptions.md b/doc/rule-descriptions.md index 75787363d5..c2ac904270 100644 --- a/doc/rule-descriptions.md +++ b/doc/rule-descriptions.md @@ -86,9 +86,9 @@ These rules are disabled by default, until WCAG 2.2 is more widely adopted and required. -| Rule ID | Description | Impact | Tags | Issue Type | ACT Rules | -| :----------------------------------------------------------------------------------------------- | :------------------------------------------------- | :------ | :--------------------------------------------- | :------------------------- | :-------- | -| [target-size](https://dequeuniversity.com/rules/axe/4.9/target-size?application=RuleDescription) | Ensure touch target have sufficient size and space | Serious | cat.sensory-and-visual-cues, wcag22aa, wcag258 | failure, needs review | | +| Rule ID | Description | Impact | Tags | Issue Type | ACT Rules | +| :----------------------------------------------------------------------------------------------- | :-------------------------------------------------- | :------ | :--------------------------------------------- | :------------------------- | :-------- | +| [target-size](https://dequeuniversity.com/rules/axe/4.9/target-size?application=RuleDescription) | Ensure touch targets have sufficient size and space | Serious | cat.sensory-and-visual-cues, wcag22aa, wcag258 | failure, needs review | | ## Best Practices Rules @@ -115,7 +115,7 @@ Rules that do not necessarily conform to WCAG success criterion but are industry | [landmark-no-duplicate-contentinfo](https://dequeuniversity.com/rules/axe/4.9/landmark-no-duplicate-contentinfo?application=RuleDescription) | Ensures the document has at most one contentinfo landmark | Moderate | cat.semantics, best-practice | failure | | | [landmark-no-duplicate-main](https://dequeuniversity.com/rules/axe/4.9/landmark-no-duplicate-main?application=RuleDescription) | Ensures the document has at most one main landmark | Moderate | cat.semantics, best-practice | failure | | | [landmark-one-main](https://dequeuniversity.com/rules/axe/4.9/landmark-one-main?application=RuleDescription) | Ensures the document has a main landmark | Moderate | cat.semantics, best-practice | failure | | -| [landmark-unique](https://dequeuniversity.com/rules/axe/4.9/landmark-unique?application=RuleDescription) | Landmarks should have a unique role or role/label/title (i.e. accessible name) combination | Moderate | cat.semantics, best-practice | failure | | +| [landmark-unique](https://dequeuniversity.com/rules/axe/4.9/landmark-unique?application=RuleDescription) | Ensures landmarks are unique | Moderate | cat.semantics, best-practice | failure | | | [meta-viewport-large](https://dequeuniversity.com/rules/axe/4.9/meta-viewport-large?application=RuleDescription) | Ensures <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.9/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.9/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) | diff --git a/lib/checks/aria/aria-errormessage.json b/lib/checks/aria/aria-errormessage.json index 84901729af..e238d7f654 100644 --- a/lib/checks/aria/aria-errormessage.json +++ b/lib/checks/aria/aria-errormessage.json @@ -11,9 +11,9 @@ "hidden": "aria-errormessage value `${data.values}` cannot reference a hidden element" }, "incomplete": { - "singular": "ensure aria-errormessage value `${data.values}` references an existing element", - "plural": "ensure aria-errormessage values `${data.values}` reference existing elements", - "idrefs": "unable to determine if aria-errormessage element exists on the page: ${data.values}" + "singular": "Ensure aria-errormessage value `${data.values}` references an existing element", + "plural": "Ensure aria-errormessage values `${data.values}` reference existing elements", + "idrefs": "Unable to determine if aria-errormessage element exists on the page: ${data.values}" } } } diff --git a/lib/checks/forms/autocomplete-appropriate.json b/lib/checks/forms/autocomplete-appropriate.json index dda69e3b06..0e9940de8a 100644 --- a/lib/checks/forms/autocomplete-appropriate.json +++ b/lib/checks/forms/autocomplete-appropriate.json @@ -5,8 +5,8 @@ "metadata": { "impact": "serious", "messages": { - "pass": "the autocomplete value is on an appropriate element", - "fail": "the autocomplete value is inappropriate for this type of input" + "pass": "The autocomplete value is on an appropriate element", + "fail": "The autocomplete value is inappropriate for this type of input" } } } diff --git a/lib/checks/forms/autocomplete-valid.json b/lib/checks/forms/autocomplete-valid.json index 0906e4b89a..25ca50724d 100644 --- a/lib/checks/forms/autocomplete-valid.json +++ b/lib/checks/forms/autocomplete-valid.json @@ -4,8 +4,8 @@ "metadata": { "impact": "serious", "messages": { - "pass": "the autocomplete attribute is correctly formatted", - "fail": "the autocomplete attribute is incorrectly formatted" + "pass": "The autocomplete attribute is correctly formatted", + "fail": "The autocomplete attribute is incorrectly formatted" } }, "options": { diff --git a/lib/checks/shared/aria-labelledby.json b/lib/checks/shared/aria-labelledby.json index f09d75fdad..0207baf864 100644 --- a/lib/checks/shared/aria-labelledby.json +++ b/lib/checks/shared/aria-labelledby.json @@ -6,7 +6,7 @@ "messages": { "pass": "aria-labelledby attribute exists and references elements that are visible to screen readers", "fail": "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", - "incomplete": "ensure aria-labelledby references an existing element" + "incomplete": "Ensure aria-labelledby references an existing element" } } } diff --git a/lib/checks/shared/presentational-role.json b/lib/checks/shared/presentational-role.json index 7b8dfb3b08..152477696b 100644 --- a/lib/checks/shared/presentational-role.json +++ b/lib/checks/shared/presentational-role.json @@ -4,7 +4,7 @@ "metadata": { "impact": "minor", "messages": { - "pass": "Element's default semantics were overriden with role=\"${data.role}\"", + "pass": "Element's default semantics were overridden with role=\"${data.role}\"", "fail": { "default": "Element's default semantics were not overridden with role=\"none\" or role=\"presentation\"", "globalAria": "Element's role is not presentational because it has a global ARIA attribute", diff --git a/lib/checks/shared/role-none.json b/lib/checks/shared/role-none.json index dfae40a5bf..dd46b9148e 100644 --- a/lib/checks/shared/role-none.json +++ b/lib/checks/shared/role-none.json @@ -12,7 +12,7 @@ "metadata": { "impact": "minor", "messages": { - "pass": "Element's default semantics were overriden with role=\"none\"", + "pass": "Element's default semantics were overridden with role=\"none\"", "fail": "Element's default semantics were not overridden with role=\"none\"" } } diff --git a/lib/checks/shared/role-presentation.json b/lib/checks/shared/role-presentation.json index 8615e6c356..d083000af4 100644 --- a/lib/checks/shared/role-presentation.json +++ b/lib/checks/shared/role-presentation.json @@ -12,7 +12,7 @@ "metadata": { "impact": "minor", "messages": { - "pass": "Element's default semantics were overriden with role=\"presentation\"", + "pass": "Element's default semantics were overridden with role=\"presentation\"", "fail": "Element's default semantics were not overridden with role=\"presentation\"" } } diff --git a/lib/rules/landmark-unique.json b/lib/rules/landmark-unique.json index dff8639ad5..2c5c2e3db3 100644 --- a/lib/rules/landmark-unique.json +++ b/lib/rules/landmark-unique.json @@ -4,8 +4,8 @@ "selector": "[role=banner], [role=complementary], [role=contentinfo], [role=main], [role=navigation], [role=region], [role=search], [role=form], form, footer, header, aside, main, nav, section", "tags": ["cat.semantics", "best-practice"], "metadata": { - "help": "Ensures landmarks are unique", - "description": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination" + "description": "Ensures landmarks are unique", + "help": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination" }, "matches": "landmark-unique-matches", "all": [], diff --git a/lib/rules/table-duplicate-name.json b/lib/rules/table-duplicate-name.json index da3a076c00..e274b22ae9 100644 --- a/lib/rules/table-duplicate-name.json +++ b/lib/rules/table-duplicate-name.json @@ -5,7 +5,7 @@ "tags": ["cat.tables", "best-practice"], "metadata": { "description": "Ensure the element does not contain the same text as the summary attribute", - "help": "tables should not have the same summary and caption" + "help": "Tables should not have the same summary and caption" }, "all": [], "any": [], diff --git a/lib/rules/target-size.json b/lib/rules/target-size.json index 7a03bd0309..42b3e44ded 100644 --- a/lib/rules/target-size.json +++ b/lib/rules/target-size.json @@ -6,7 +6,7 @@ "matches": "widget-not-inline-matches", "tags": ["cat.sensory-and-visual-cues", "wcag22aa", "wcag258"], "metadata": { - "description": "Ensure touch target have sufficient size and space", + "description": "Ensure touch targets have sufficient size and space", "help": "All touch targets must be 24px large, or leave sufficient space" }, "all": [], diff --git a/locales/_template.json b/locales/_template.json index 9aa84b106a..e52124c82f 100644 --- a/locales/_template.json +++ b/locales/_template.json @@ -282,8 +282,8 @@ "help": "Document should have one main landmark" }, "landmark-unique": { - "help": "Ensures landmarks are unique", - "description": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination" + "description": "Ensures landmarks are unique", + "help": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination" }, "link-in-text-block": { "description": "Ensure links are distinguished from surrounding text in a way that does not rely on color", @@ -383,14 +383,14 @@ }, "table-duplicate-name": { "description": "Ensure the element does not contain the same text as the summary attribute", - "help": "tables should not have the same summary and caption" + "help": "Tables should not have the same summary and caption" }, "table-fake-caption": { "description": "Ensure that tables with a caption use the element.", "help": "Data or header cells must not be used to give caption to a data table." }, "target-size": { - "description": "Ensure touch target have sufficient size and space", + "description": "Ensure touch targets have sufficient size and space", "help": "All touch targets must be 24px large, or leave sufficient space" }, "td-has-header": { @@ -461,9 +461,9 @@ "hidden": "aria-errormessage value `${data.values}` cannot reference a hidden element" }, "incomplete": { - "singular": "ensure aria-errormessage value `${data.values}` references an existing element", - "plural": "ensure aria-errormessage values `${data.values}` reference existing elements", - "idrefs": "unable to determine if aria-errormessage element exists on the page: ${data.values}" + "singular": "Ensure aria-errormessage value `${data.values}` references an existing element", + "plural": "Ensure aria-errormessage values `${data.values}` reference existing elements", + "idrefs": "Unable to determine if aria-errormessage element exists on the page: ${data.values}" } }, "aria-hidden-body": { @@ -678,12 +678,12 @@ } }, "autocomplete-appropriate": { - "pass": "the autocomplete value is on an appropriate element", - "fail": "the autocomplete value is inappropriate for this type of input" + "pass": "The autocomplete value is on an appropriate element", + "fail": "The autocomplete value is inappropriate for this type of input" }, "autocomplete-valid": { - "pass": "the autocomplete attribute is correctly formatted", - "fail": "the autocomplete attribute is incorrectly formatted" + "pass": "The autocomplete attribute is correctly formatted", + "fail": "The autocomplete attribute is incorrectly formatted" }, "accesskeys": { "pass": "Accesskey attribute value is unique", @@ -961,7 +961,7 @@ "aria-labelledby": { "pass": "aria-labelledby attribute exists and references elements that are visible to screen readers", "fail": "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", - "incomplete": "ensure aria-labelledby references an existing element" + "incomplete": "Ensure aria-labelledby references an existing element" }, "avoid-inline-spacing": { "pass": "No inline styles with '!important' that affect text spacing has been specified", @@ -1044,7 +1044,7 @@ } }, "presentational-role": { - "pass": "Element's default semantics were overriden with role=\"${data.role}\"", + "pass": "Element's default semantics were overridden with role=\"${data.role}\"", "fail": { "default": "Element's default semantics were not overridden with role=\"none\" or role=\"presentation\"", "globalAria": "Element's role is not presentational because it has a global ARIA attribute", @@ -1054,11 +1054,11 @@ } }, "role-none": { - "pass": "Element's default semantics were overriden with role=\"none\"", + "pass": "Element's default semantics were overridden with role=\"none\"", "fail": "Element's default semantics were not overridden with role=\"none\"" }, "role-presentation": { - "pass": "Element's default semantics were overriden with role=\"presentation\"", + "pass": "Element's default semantics were overridden with role=\"presentation\"", "fail": "Element's default semantics were not overridden with role=\"presentation\"" }, "svg-non-empty-title": {