aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGabriel Orisaka <orisaka@gmail.com>2016-08-02 23:25:49 -0300
committerAlex Gaynor <alex.gaynor@gmail.com>2016-08-02 22:25:49 -0400
commitb6e0ba0fb7bf0eccdcf84c730ea23bb4544f427d (patch)
tree1b8d0c56ef413e0232fc7a7cfe53c97e5773c290
parent9e75830ad17f36f5351df0c9a63fde083bf7d66b (diff)
downloadcryptography-b6e0ba0fb7bf0eccdcf84c730ea23bb4544f427d.tar.gz
cryptography-b6e0ba0fb7bf0eccdcf84c730ea23bb4544f427d.tar.bz2
cryptography-b6e0ba0fb7bf0eccdcf84c730ea23bb4544f427d.zip
Add recommendation about terminology (#3079)
-rw-r--r--docs/development/submitting-patches.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst
index 475e7037..63eed19d 100644
--- a/docs/development/submitting-patches.rst
+++ b/docs/development/submitting-patches.rst
@@ -126,6 +126,11 @@ should begin with the "Hazardous Materials" warning:
.. hazmat::
+Always prefer terminology that is most broadly accepted. For example:
+
+* When referring to class instances use "an instance of ``Foo``"
+ instead of "a ``Foo`` provider".
+
When referring to a hypothetical individual (such as "a person receiving an
encrypted message") use gender neutral pronouns (they/them/their).