knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

avoid 'should' in documentation (#4162) 

* avoid 'should' in documentation

* fix whitespaces
This commit is contained in:
Sankalp Rangare 2021-09-10 00:25:58 +05:30 committed by GitHub
parent 9ef8901395
commit 375e925b5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/help/contributor/style-guide/word-and-phrase-list.md
View File

@ -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. |