Skip to content

Commit a7be68a

Browse files
committed
Minor tweaks
1 parent 48d7a5b commit a7be68a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

contributing/documentation/standards.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -175,24 +175,24 @@ In addition, documentation follows these rules:
175175
* his or hers, use theirs
176176
* himself or herself, use themselves
177177

178-
* **Avoid belittling words**: People read documentation because they know very little about
179-
a specific topic or are even completely new to it. Things that seem "obvious" or "simple"
180-
for the person documenting it, can be the exact opposite for the reader. To make sure everybody
181-
feels comfortable when reading the documentation, try to avoid words like:
178+
* **Avoid belittling words**: People read documentation because they know very
179+
little about a specific topic or are even completely new to it. Things that
180+
seem "obvious" or "simple" for the person documenting it, can be the exact
181+
opposite for the reader. To make sure everybody feels comfortable when reading
182+
the documentation, try to avoid words like:
182183

183-
* simply
184-
* just
184+
* basically
185+
* clearly
185186
* easy/easily
186-
* quick/quickly
187-
* of course
187+
* just
188188
* logically
189-
* clearly
190-
* obviously
191189
* merely
192-
* basically
190+
* obviously
191+
* of course
192+
* quick/quickly
193+
* simply
193194
* trivial
194195

195-
196196
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
197197
.. _`Twig Coding Standards`: https://twig.symfony.com/doc/2.x/coding_standards.html
198198
.. _`reserved by the IANA`: http://tools.ietf.org/html/rfc2606#section-3

0 commit comments

Comments
 (0)