Skip to content

Commit e7923c0

Browse files
committed
docs: Explain our shift in terminology
1 parent 103ad99 commit e7923c0

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

docs/design_guide.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. role:: strike
2+
13
Design Guide
24
============
35

@@ -46,6 +48,41 @@ not have the ``adafruit_`` module or package prefix.
4648

4749
Both should have the CircuitPython repository topic on GitHub.
4850

51+
Terminology
52+
-----------
53+
54+
As our Code of Conduct states, we strive to use "welcoming and inclusive
55+
language." Whether it is in documentation or in code, the words we use matter.
56+
This means we disfavor language that due to historical and social context can
57+
make community members and potential community members feel unwelcome.
58+
59+
There are specific terms to avoid except where technical limitations require it.
60+
While specific cases may call for other terms, consider using these suggested
61+
terms first:
62+
63+
+--------------------+---------------------+
64+
| Preferred | Deprecated |
65+
+====================+=====================+
66+
| Main (device) | :strike:`Master` |
67+
+--------------------+---------------------+
68+
| Peripheral | :strike:`Slave` |
69+
+--------------------+ +
70+
| Sensor | |
71+
+--------------------+ +
72+
| Secondary (device) | |
73+
+--------------------+---------------------+
74+
| Denylist | :strike:`Blacklist` |
75+
+--------------------+---------------------+
76+
| Allowlist | :strike:`Whitelist` |
77+
+--------------------+---------------------+
78+
79+
Note that "technical limitations" refers e.g., to the situation where an
80+
upstream library or URL has to contain those substrings in order to work.
81+
However, when it comes to documentation and the names of parameters and
82+
properties in CircuitPython, we will use alternate terms even if this breaks
83+
tradition with past practice.
84+
85+
4986
.. _lifetime-and-contextmanagers:
5087

5188
Lifetime and ContextManagers

docs/static/customstyle.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@
2424
overflow: visible !important;
2525
}
2626
}
27+
28+
.strike {
29+
text-decoration: line-through;
30+
}

0 commit comments

Comments
 (0)