docs: improve descriptions for performance_mode #5055
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
removes the frequent repetition of the word will for the performance mode option descriptions. Improves the readability and makes the descriptions easier to skim.
removes the frequent repetition of the word will for the performance mode option descriptions. Improves the readability and makes the descriptions easier to skim.
rfay
changed the title
gilbertsoft
approved these changes
Jul 1, 2023
|
Download the artifacts for this pull request:
See Testing a PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
The descriptions for the performance mode options all started with the word
will. That is redundant and difficult to scan. Ginny Reddish published a paper about screen reader users a few years ago which still applies (https://redish.net/wp-content/uploads/Theorfanos_Redish_InteractionsPaperAuthorsVer.pdf - page 4). Those frequent repetitions are hard to scan for screen reader users. Screen reader users scan with their ears while sighted users scan with their eyes. So by removing the redundant bitwillwould improve the readability for both groups imho.How This PR Solves The Issue
Manual Testing Instructions
Automated Testing Overview
Related Issue Link(s)
Release/Deployment Notes