|
| 1 | +.. role:: strike |
| 2 | + |
1 | 3 | Design Guide
|
2 | 4 | ============
|
3 | 5 |
|
@@ -46,6 +48,41 @@ not have the ``adafruit_`` module or package prefix.
|
46 | 48 |
|
47 | 49 | Both should have the CircuitPython repository topic on GitHub.
|
48 | 50 |
|
| 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 | + |
49 | 86 | .. _lifetime-and-contextmanagers:
|
50 | 87 |
|
51 | 88 | Lifetime and ContextManagers
|
|
0 commit comments