8000 Merge pull request #3034 from jepler/terminology-cleanup · kdb424/circuitpython@bc4c745 · GitHub
[go: up one dir, main page]
Skip to content

Commit bc4c745

Browse files
tannewttannewt
authored
Merge pull request adafruit#3034 from jepler/terminology-cleanup
M/S Terminology cleanup
2 parents 07eb7d6 + 66d031f commit bc4c745

File tree

82 files changed

+869
-2410
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+869
-2410
lines changed

‎CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22
Please note that this project is released with a
3-
[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md).
3+
[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md).
44
By participating in this project you agree to abide by its terms. Participation
55
covers any forum used to converse about CircuitPython including unofficial and official spaces. Failure to do
66
so will result in corrective actions such as time out or ban from the project.

‎README.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ Contributing
5555
------------
5656

5757
See
58-
`CONTRIBUTING.md <https://github.com/adafruit/circuitpython/blob/master/CONTRIBUTING.md>`__
58+
`CONTRIBUTING.md <https://github.com/adafruit/circuitpython/blob/main/CONTRIBUTING.md>`__
5959
for full guidelines but please be aware that by contributing to this
6060
project you are agreeing to the `Code of
61-
Conduct <https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md>`__.
61+
Conduct <https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md>`__.
6262
Contributors who follow the `Code of
63-
Conduct <https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md>`__
63+
Conduct <https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md>`__
6464
are welcome to submit pull requests and they will be promptly reviewed
6565
by project admins. Please join the
6666
`Discord <https://adafru.it/discord>`__ too.
@@ -96,7 +96,6 @@ CircuitPython:
9696

9797
- Supports native USB on all boards, allowing file editing without special tools.
9898
- Supports only SAMD21, SAMD51, nRF52840, CXD56, STM32F4 and i.MX RT ports.
99-
- Tracks MicroPython's releases (not master).
10099
- Floats (aka decimals) are enabled for all builds.
101100
- Error messages are translated into 10+ languages.
102101
- Does not support concurrency within Python (including interrupts and threading). Some concurrency
@@ -211,8 +210,8 @@ The remaining port directories not listed above are in the repo to maintain comp
211210

212211
`back to top <#circuitpython>`__
213212

214-
.. |Build Status| image:: https://travis-ci.com/adafruit/circuitpython.svg?branch=master
215-
:target: https://travis-ci.org/adafruit/circuitpython
213+
.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
214+
:target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
216215
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
217216
:target: http://circuitpython.readthedocs.io/
218217
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The latest documentation can be found at:
55
http://circuitpython.readthedocs.io/en/latest/
66

77
The documentation you see there is generated from the files in the whole tree:
8-
https://github.com/adafruit/circuitpython/tree/master
8+
https://github.com/adafruit/circuitpython/tree/main
99

1010
Building the documentation locally
1111
----------------------------------

‎docs/design_guide.rst

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
.. role:: strike
2+
13
Design Guide
24
============
35

46
This guide covers a variety of development practices for CircuitPython core and library APIs. These
57
APIs are both `built-into CircuitPython
6-
<https://github.com/adafruit/circuitpython/tree/master/shared-bindings>`_ and those that are
8+
<https://github.com/adafruit/circuitpython/tree/main/shared-bindings>`_ and those that are
79
`distributed on GitHub <https://github.com/search?utf8=%E2%9C%93&q=topic%3Acircuitpython&type=>`_
810
and in the `Adafruit <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ and `Community
911
<https://github.com/adafruit/CircuitPython_Community_Bundle/>`_ bundles. Consistency with these
@@ -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/porting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ as a natural "TODO" list. An example minimal build list is shown below:
6464
CIRCUITPY_ROTARYIO = 0
6565
CIRCUITPY_RTC = 0
6666
CIRCUITPY_FREQUENCYIO = 0
67-
CIRCUITPY_I2CSLAVE = 0
67+
CIRCUITPY_I2CPERIPHERAL = 0
6868
CIRCUITPY_DISPLAYIO = 0 # Requires SPI, PulseIO (stub ok)
6969
7070
# These modules are implemented in shared-module/ - they can be included in

‎docs/redirects.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ shared-bindings/pulseio/PWMOut.rst shared-bindings/pulseio/#pulseio.PWMOut
3232
shared-bindings/pulseio/PulseIn.rst shared-bindings/pulseio/#pulseio.PulseIn
3333
shared-bindings/pulseio/PulseOut.rst shared-bindings/pulseio/#pulseio.PulseOut
3434
shared-bindings/time/struct_time.rst shared-bindings/time/#time.struct_time
35-
shared-bindings/i2cslave/I2CSlave.rst shared-bindings/i2cslave/#i2cslave.I2CSlave
36-
shared-bindings/i2cslave/I2CSlaveRequest.rst shared-bindings/i2cslave/#i2cslave.I2CSlaveRequest
35+
shared-bindings/i2cslave/I2CSlave.rst shared-bindings/i2cperipheral/#i2cperipheral.I2CPeripheral
36+
shared-bindings/i2cslave/I2CSlaveRequest.rst shared-bindings/i2cperipheral/#i2cperipheral.I2CPeripheralRequest
3737
shared-bindings/nvm/ByteArray.rst shared-bindings/nvm/#nvm.ByteArray
3838
shared-bindings/busio/I2C.rst shared-bindings/busio/#busio.I2C
3939
shared-bindings/busio/OneWire.rst shared-bindings/busio/#busio.OneWire

‎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)
0