diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-12-12 20:24:42 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-12-12 20:24:42 -0600 |
| commit | be42d096746ca211d0e1b21874017e75765dc40b (patch) | |
| tree | 9a986b6b76e35a51a05d5e47b6772cbad9aa5fb7 /docs | |
| parent | 963349078dc09ca36f5d7ad25e182ff11f6bb106 (diff) | |
| parent | 985a398e85f7a9b332b52d9c7d49690f1b9cd732 (diff) | |
| download | cryptography-be42d096746ca211d0e1b21874017e75765dc40b.tar.gz cryptography-be42d096746ca211d0e1b21874017e75765dc40b.tar.bz2 cryptography-be42d096746ca211d0e1b21874017e75765dc40b.zip | |
Merge pull request #1519 from alex/class-naming
Fixes #1518 -- document the captilazation of lcass names
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/submitting-patches.rst | 3 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst index ff650c4f..810b8748 100644 --- a/docs/development/submitting-patches.rst +++ b/docs/development/submitting-patches.rst @@ -25,6 +25,9 @@ configuration. You can also run the ``tox`` job with ``tox -e pep8``. `Write comments as complete sentences.`_ +Class names which contains acronyms or initialisms should always be +capitalized. A class should be named ``HTTPClient``, not ``HttpClient``. + Every code file must start with the boilerplate licensing notice: .. code-block:: python diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index b7b33436..003e37d5 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -24,6 +24,7 @@ fernet Fernet hazmat indistinguishability +initialisms interoperable introspectability invariants |