Skip to content

Commit 3c5e2c7

Browse files
committed
Move "specific words" and "type names" down in page
The "specific words" section and the new "type names" which follows it are now below the "simple language" and "charged terminology" sections. No content was changed in the course of this. (NB: git's diff algorithm selects opposite pieces of text based on size)
1 parent 1328257 commit 3c5e2c7

1 file changed

Lines changed: 29 additions & 28 deletions

File tree

documentation/style-guide.rst

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,35 @@ of these entities are not assigned any special markup, but the preferred
5858
spellings are given in :ref:`specific words` to aid authors in maintaining the
5959
consistency of presentation in the Python documentation.
6060

61+
62+
Use simple language
63+
===================
64+
65+
Avoid esoteric phrasing where possible. Our audience is world-wide and may not
66+
be native English speakers.
67+
68+
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
69+
such as "for example" or "that is."
70+
71+
72+
Charged terminology to avoid
73+
============================
74+
75+
Avoid terminology that may be considered insensitive or exclusionary.
76+
77+
.. list-table::
78+
:header-rows: 1
79+
80+
* - Avoid
81+
- Instead
82+
* - whitelist
83+
- allowlist
84+
* - blacklist
85+
- blocklist, denylist
86+
* - master/slave
87+
- main, parent/child, server/client, primary/secondary
88+
89+
6190
.. _specific words:
6291

6392
Specific words
@@ -137,34 +166,6 @@ and "partial function" may be used to describe an application of
137166
better than the type name itself would, and put them in lowercase.
138167

139168

140-
Use simple language
141-
===================
142-
143-
Avoid esoteric phrasing where possible. Our audience is world-wide and may not
144-
be native English speakers.
145-
146-
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
147-
such as "for example" or "that is."
148-
149-
150-
Charged terminology to avoid
151-
============================
152-
153-
Avoid terminology that may be considered insensitive or exclusionary.
154-
155-
.. list-table::
156-
:header-rows: 1
157-
158-
* - Avoid
159-
- Instead
160-
* - whitelist
161-
- allowlist
162-
* - blacklist
163-
- blocklist, denylist
164-
* - master/slave
165-
- main, parent/child, server/client, primary/secondary
166-
167-
168169
.. index:: diataxis
169170
.. _diataxis:
170171

0 commit comments

Comments
 (0)