Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitc0ffcfe

Browse files
committed
Merge branch '4.3' into 4.4
* 4.3: Added a section about belittling words to the documentation standars
2 parentsad5f953 +6e48add commitc0ffcfe

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

‎contributing/documentation/standards.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,24 @@ In addition, documentation follows these rules:
173173
* his or hers, use theirs
174174
* himself or herself, use themselves
175175

176+
* **Avoid belittling words**: People read documentation because they know very
177+
little about a specific topic or are even completely new to it. Things that
178+
seem "obvious" or "simple" for the person documenting it, can be the exact
179+
opposite for the reader. To make sure everybody feels comfortable when reading
180+
the documentation, try to avoid words like:
181+
182+
* basically
183+
* clearly
184+
* easy/easily
185+
* just
186+
* logically
187+
* merely
188+
* obviously
189+
* of course
190+
* quick/quickly
191+
* simply
192+
* trivial
193+
176194
.. _`the Sphinx documentation`:http://sphinx-doc.org/rest.html#source-code
177195
.. _`Twig Coding Standards`:https://twig.symfony.com/doc/2.x/coding_standards.html
178196
.. _`reserved by the IANA`:http://tools.ietf.org/html/rfc2606#section-3

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp