From ee1d96c077b0124cdbd6aada1da2bdc4b21ae594 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Fri, 12 Dec 2014 10:50:46 -0800 Subject: Fixes #1518 -- document the captilazation of lcass names --- docs/development/submitting-patches.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs') 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 -- cgit v1.2.3 From 985a398e85f7a9b332b52d9c7d49690f1b9cd732 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Fri, 12 Dec 2014 14:09:53 -0800 Subject: this is a word --- docs/spelling_wordlist.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') 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 -- cgit v1.2.3