10000 Remove assumption about why people read the documentation · symfony/symfony-docs@a4eb641 · GitHub
[go: up one dir, main page]

Skip to content

Commit a4eb641

Browse files
committed
Remove assumption about why people read the documentation
1 parent 11ca468 commit a4eb641

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

contributing/documentation/standards.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,10 @@ 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
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:
178+
* **Avoid belittling words**: Things that seem "obvious" or "simple" for the
179+
person documenting it, can be the exact opposite for the reader. To make sure
180+
everybody feels comfortable when reading the documentation, try to avoid words
181+
like:
183182

184183
* basically
185184
* clearly

0 commit comments

Comments
 (0)
0