Skip to content

Commit f92c414

Browse files
Commit
1 parent 3a8b71e commit f92c414

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

documentation/style-guide.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,16 @@ Unix
103103
Use simple language
104104
===================
105105

106-
Avoid esoteric phrasing where possible. Our audience is world-wide and may not
107-
be native English speakers.
108-
109-
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
110-
such as "for example" or "that is."
106+
The documentation has a world-wide audience of varying English proficiency.
107+
To make the documentation more accessible and inclusive, the following should be
108+
avoided:
109+
110+
- Esoteric phrasing.
111+
- Abbreviations, such as Latin "e.g." or "i.e.," or symbols, such as the
112+
ampersand ('&'), where English words will do, such as
113+
"for example", "that is" and "and," respectively.
114+
- Idioms, as they are often confusing to non-native speakers and
115+
are difficult to translate.
111116

112117

113118
.. index:: diataxis

0 commit comments

Comments
 (0)