From 03d381c2f9da1a6eb65ac18c07e5b61ffd2438d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Tue, 20 Oct 2015 14:40:09 -0400 Subject: [PATCH] describe the current style guide in documentation --- docs/development.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/development.rst b/docs/development.rst index 6ae364dc1..75ec53dfc 100644 --- a/docs/development.rst +++ b/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 +`_, with 120 columns +instead of 79. We do *not* use form-feed (``^L``) characters to +separate sections either. The `flake8 +`_ commandline tool should be used to +check for style errors before sending pull requests. Building a development environment ----------------------------------