Skip to content

Commit d2615d2

Browse files
authored
Update word-usage.adoc
pre-commit Signed-off-by: Kersten Richter <[email protected]>
1 parent 7216cbb commit d2615d2

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/word-usage.adoc

+2-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ After (once):: Use "after" to indicate a sequence of events. Use "once" to indic
99

1010
Also:: use to mean additionally rather than alternatively.
1111

12-
As:: Don't use "as" to mean "because". For example, don't say "Use the correct version as the wrong version can cause issues." Instead, "Use the correct version because the wrong version can cause issues." Use "as" to compare.
12+
As:: Don't use "as" to mean "because". For example, don't say "Use the correct version as the wrong version can cause issues." Instead, "Use the correct version because the wrong version can cause issues." Use "as" to compare.
1313

1414
Because (since or as):: Use "because" to mean “for the reason that" or "due to the fact that". "As" is a comparison. "Since" means a timeline.
1515

@@ -51,7 +51,7 @@ Might (can, must, may, should, shall, will)::
5151
- Use "should" to indicate a recommended, but optional action. Consider using an alternative phrase instead, such as "we recommend." Do not use "should" to indicate something that might happen. "After you push the power button, the system should turn on." Instead, be bold! "After you push the power button, the system turns on."
5252
- Use "must" to indicate a rquired action or condition. "The system must be powered on."
5353
- Use "shall" to indicate something must happen, but has not yet occured. "The state of the `BUSY` bit shall change only in response to a write to the register."
54-
- Use "will" very sparingly. Use the present tense for most technical documentation. "The system will power on" becomes "The system powers on." Use future or past tense if it is required to convey the correct meaning only.
54+
- Use "will" very sparingly. Use the present tense for most technical documentation. "The system will power on" becomes "The system powers on." Use future or past tense if it is required to convey the correct meaning only.
5555

5656
Numbers:: Use Arabic for numbers greater than 10. Use words for numbers 1 through 10. Except in the following cases.
5757
- If the numbers are values, use Arabic. "Valid input is 1-10."
@@ -101,4 +101,3 @@ Will (can, might, must, may, should, shall, will)::
101101
- Use "must" to indicate a rquired action or condition. "The system must be powered on."
102102
- Use "shall" to indicate something must happen, but has not yet occured. "The state of the `BUSY` bit shall change only in response to a write to the register."
103103
- Use "will" very sparingly. Use the present tense for most technical documentation. Use future or past tense if it is required to convey the correct meaning only.
104-

0 commit comments

Comments
 (0)