Permalink
Browse files

CONTRIBUTING: Make it explicit we don't like blank lines

  • Loading branch information...
1 parent 2a65efa commit 9ae9efe1563975faec9bf0670234ab13a02a90c0 @pekkaklarck pekkaklarck committed Jun 17, 2016
Showing with 6 additions and 5 deletions.
  1. +6 −5 CONTRIBUTING.rst
View
@@ -121,21 +121,22 @@ support both Python 2 and Python 3.
Whitespace
''''''''''
-We are pretty picky about using whitespace. We use blank lines and whitespace
-in expressions as dictated by `PEP-8`_, but we also follow these rules:
+We are pretty picky about using whitespace. We follow `PEP-8`_ in how to use
+blank lines and whitespace in general, but we also have some stricter rules:
+- No blank lines inside functions.
- Indentation using spaces, not tabs.
- No trailing spaces.
- No extra empty lines at the end of the file.
- Files must end with a newline.
-The above rules are good with most other code too. Any decent editor or IDE
-can be configured to automatically format files according to them.
+Most of these rules are such that any decent text editor or IDE can be
+configured to automatically format files according to them.
Docstrings
''''''''''
-Docstrings should be added to public APIs but are not generally needed in
+Docstrings should be added to public APIs, but they are not generally needed in
internal code. When docstrings are added, they should follow `PEP-257
<https://www.python.org/dev/peps/pep-0257/>`_. See `API documentation`_
section below for more details about documentation syntax, generating

0 comments on commit 9ae9efe

Please sign in to comment.