Remove use of parentheses on its own sentence as per WAI Style Guide.#2427
Remove use of parentheses on its own sentence as per WAI Style Guide.#2427daniel-montalvo wants to merge 2 commits into
Conversation
Clarified explanation of the label in name algorithm regarding visible inner text and whitespace handling.
❌ Deploy Preview for act-rules failed.
|
| #### Passed Example 8 | ||
|
|
||
| (Similar to previous example.) This link has [visible inner text][] that, according to the [label in name algorithm][], is contained within the [accessible name][]. This example shows why the [label in name algorithm][] uses the [visible inner text][] and not the [visible text content][]: the `<h6>` tags insert whitespace into the result in the former but not the latter. | ||
| This link has [visible inner text][] that, according to the [label in name algorithm][], is contained within the [accessible name][]. This example shows why the [label in name algorithm][] uses the [visible inner text][] and not the [visible text content][]: the `<h6>` tags insert whitespace into the result in the former but not the latter. |
There was a problem hiding this comment.
| This link has [visible inner text][] that, according to the [label in name algorithm][], is contained within the [accessible name][]. This example shows why the [label in name algorithm][] uses the [visible inner text][] and not the [visible text content][]: the `<h6>` tags insert whitespace into the result in the former but not the latter. | |
| Similar to previous example. This link has [visible inner text][] that, according to the [label in name algorithm][], is contained within the [accessible name][]. This example shows why the [label in name algorithm][] uses the [visible inner text][] and not the [visible text content][]: the `<h6>` tags insert whitespace into the result in the former but not the latter. |
I have no strong opinion on parenthesis. I think there's value in the words "Similar to previous example" somehow. My rationale is that, because this example's paragraph copied about 95% of its words from the previous example's paragraph, if we don't warn the reader about that somehow, then we will force the reader to read this example more carefully, and that's unnecessary mental effort.
There was a problem hiding this comment.
Thanks for giving the context @dan-tripp-siteimprove
It may be probably best to just focus these two descriptions on what makes the two examples different, not on what makes them similar.
If we keep "Similar to previous example.", I would instead use a comma to avoid having an incomplete starting sentence.
Similar to previous example, this link has [...]
There was a problem hiding this comment.
That sounds good to me.
See https://wai-website-theme.netlify.app/style-guide/structure-presentation/#parentheses-optional
Need for Call for Review:
This can be merged with 1 approval << choose reason: editorial changes to website/test code, adding new contributor, other (explain). >>
This will not require a Call for Review, editorial changes (including to the applicability, expectation or examples section).
Pull Request Etiquette
When creating PR:
developbranch (left side).After creating PR:
Rule,DefinitionorChore.When merging a PR:
How to Review And Approve