Browse Source

describe the current style guide in documentation

Antoine Beaupré 9 years ago
parent
commit
03d381c2f9
1 changed files with 9 additions and 0 deletions
  1. 9 0
      docs/development.rst

+ 9 - 0
docs/development.rst

@@ -9,6 +9,15 @@ This chapter will get you started with |project_name|' development.
 |project_name| is written in Python (with a little bit of Cython and C for
 the performance critical parts).
 
+Style guide
+-----------
+
+We generally follow `pep8
+<https://www.python.org/dev/peps/pep-0008/>`_, with 120 columns
+instead of 79. We do *not* use form-feed (``^L``) characters to
+separate sections either. The `flake8
+<https://flake8.readthedocs.org/>`_ commandline tool should be used to
+check for style errors before sending pull requests.
 
 Building a development environment
 ----------------------------------