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

Jump to bottom

avoid 'should' in documentation #4162

Merged
merged 2 commits into from
Sep 9, 2021
Merged

avoid 'should' in documentation #4162

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9269d71
avoid 'should' in documentation
sankalp-r Aug 26, 2021
36ffccd
fix whitespaces
sankalp-r Sep 6, 2021
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
1 change: 1 addition & 0 deletions docs/help/contributor/style-guide/word-and-phrase-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ For the correct spellings of words, see [Merriam-Webster](https://www.merriam-we
| v<version-number>&nbsp;and&nbsp;later&nbsp;patches| or/and&nbsp;higher<br>or/and&nbsp;greater<br>or/and&nbsp;above<br>>=<br>"v2.7&nbsp;and&nbsp;later&nbsp;patches".<br>Where patches are mentioned, use three digits.| |
| v<version-number>&nbsp;or&nbsp;later&nbsp;patches | or/and&nbsp;higher<br>or/and&nbsp;greater<br>or/and&nbsp;above<br>>=<br>"v2.7&nbsp;and&nbsp;later&nbsp;patches".<br>Where patches are mentioned, use three digits.| |
| v1.6 | v1.6.X<br>v1.6.x | It's likely better to omit the wildcard, leaving the unspecified major, minor, or patch as implied. | |
| | should | Avoid "should"; it is ambiguous; "should" implies that the action is recommended but optional; if the document writer intends to mandate an action, "should" is not an appropriate choice. |