Skip to content

Commit

Permalink
Docs: don't repeat parts of PEP 8
Browse files Browse the repository at this point in the history
Don't repeat parts of PEP 8 in the Python Coding Standards docs, just
link to it once.
  • Loading branch information
Sean Hammond authored and tobes committed Nov 20, 2012
1 parent d49dea4 commit 4c7d7af
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions doc/python-coding-standards.rst
Expand Up @@ -2,32 +2,25 @@
Python Coding Standards
=======================

For python code, we follow `PEP 8`_, plus a few of our own rules. The
important bits are laid out below, but if in doubt, refer to `PEP 8`_ and
common sense.
For Python code style follow `PEP 8`_ plus the guidelines below.

Layout and formatting
---------------------
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/

- Don't use tabs. Use 4 spaces.

- Maximum line length is 79 characters.
Commit Formatting Cleanups on master
------------------------------------

- Continuation lines should align vertically within the parentheses, or with
a hanging indent. See `PEP 8's Indent Section`_ for more details.
Clean up formatting and PEP 8 issues on master, not on a feature branch.
Unless of course you're changing that piece of code anyway. This will help
avoid spurious merge conflicts, and aid in reading pull requests.

- Avoid extraneous whitespace. See `PEP 8's Whitespace Section`_ for more details.

- Clean up formatting issues in master, not on a feature branch. Unless of
course you're changing that piece of code anyway. This will help avoid
spurious merge conflicts, and aid in reading pull requests.
Use Single Quotes
-----------------

- Use the single-quote character, ``'``, rather than the double-quote
character, ``"``, for string literals.
Use the single-quote character, ``'``, rather than the double-quote character,
``"``, for string literals.

.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
.. _PEP 8's Indent Section: http://www.python.org/dev/peps/pep-0008/#indentation
.. _PEP 8's Whitespace Section: http://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements

Imports
-------
Expand Down

0 comments on commit 4c7d7af

Please sign in to comment.