diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-02-05 15:04:51 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-02-05 15:04:51 -0800 |
| commit | a54dcde3bda3f2de83b56d4456903e7bdce182e6 (patch) | |
| tree | 02fcbc27786ea55aa7d0556d236e1061354831c6 /docs/contributing.rst | |
| parent | b98699df32344ba244fa4794c6daa173919f88fe (diff) | |
| download | cryptography-a54dcde3bda3f2de83b56d4456903e7bdce182e6.tar.gz cryptography-a54dcde3bda3f2de83b56d4456903e7bdce182e6.tar.bz2 cryptography-a54dcde3bda3f2de83b56d4456903e7bdce182e6.zip | |
Document this idea
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 74b854bd..7f4c77f4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -43,6 +43,8 @@ Code When in doubt, refer to :pep:`8` for Python code. +`Write comments as complete sentences.`_ + Every code file must start with the boilerplate notice of the Apache License. Additionally, every Python code file must contain @@ -287,6 +289,7 @@ The HTML documentation index can now be found at .. _`GitHub`: https://github.com/pyca/cryptography .. _`our mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _`Write comments as complete sentences.`: http://nedbatchelder.com/blog/201401/comments_should_be_sentences.html .. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists .. _`pytest`: https://pypi.python.org/pypi/pytest .. _`tox`: https://pypi.python.org/pypi/tox |