diff options
| author | Carlton Gibson <carlton.gibson@noumenal.es> | 2019-09-05 09:54:01 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-09-05 10:15:19 +0200 |
| commit | dee22a024bcaa20d0f0c2592827b031a4f6b1fe7 (patch) | |
| tree | 01b77e6dcac6be655e7e72bd4ce9ecaed5ed8026 /docs/internals | |
| parent | 23946bdb06c459086851e7dfa6117bdc9d301466 (diff) | |
[2.2.x] Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
Co-authored-by: Tobias Kunze <r@rixx.de>
Backport of ed2d411aa84efc76baba3adf0d0f99df0e44ba57 from master
Diffstat (limited to 'docs/internals')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 47ea4c589c..187ea69783 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -129,6 +129,12 @@ Instead of: * his or hers... use theirs. * himself or herself... use themselves. +Try to avoid using words that minimise the difficulty involved in a task or +operation, such as "easily", "simply", "just", "merely", "straightforward", and +so on. People's experience may not match your expectations, and they may become +frustrated when they do not find a step as "straightforward" or "simple" as it +is implied to be. + Commonly used terms =================== |
