Skip to content

Commit 04f9d7f

Browse files
authored
style: update style guide for precise language (#3029)
Add a section on precision to the style guide, discouraging the use of 'weasel words' (e.g., 'likely', 'probably', 'maybe', 'usually') in favor of authoritative and definite statements. This establishes the standard for a series of follow-up PRs that clean up the existing course material.
1 parent 442edb0 commit 04f9d7f

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

STYLE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,16 @@ throughout the course. When editing course content, use the glossary to anchor
191191
concepts and ensure consistency in terminology. Terms should be defined and used
192192
consistently with their glossary entries.
193193

194+
### Precision
195+
196+
Avoid ["weasel words"](https://en.wikipedia.org/wiki/Weasel_word) (e.g.,
197+
"likely", "probably", "maybe", "usually") when a definite statement can be made.
198+
The course material should be clear, concise, and authoritative. If a behavior
199+
is conditional, explain the condition precisely rather than hedging.
200+
201+
When describing conventions or standard behavior, prefer "typically" (implies a
202+
norm or design characteristic) over "usually" (implies statistical frequency).
203+
194204
## Exercises
195205

196206
At the end of some sections, learners will actively engage with the material by

0 commit comments

Comments
 (0)