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:13:31 +0200 |
| commit | ed2d411aa84efc76baba3adf0d0f99df0e44ba57 (patch) | |
| tree | a545ae5ddc54d54d6b1b17f048b5426895120d1c /docs/internals/contributing | |
| parent | e2c6a0858d7d9ad85eda353076a5b46608b704a9 (diff) | |
Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
Co-authored-by: Tobias Kunze <r@rixx.de>
Diffstat (limited to 'docs/internals/contributing')
| -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 09e0629a75..0bfeeb62e3 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 =================== |
