Mercurial > pylearn
diff doc/v2_planning/API_coding_style.txt @ 1179:67f4edabb0cc
Merged
author | Olivier Delalleau <delallea@iro> |
---|---|
date | Fri, 17 Sep 2010 16:23:51 -0400 |
parents | 10bc5ebb5823 fe6c25eb1e37 |
children | 9ebd40d31a1b |
line wrap: on
line diff
--- a/doc/v2_planning/API_coding_style.txt Fri Sep 17 16:21:55 2010 -0400 +++ b/doc/v2_planning/API_coding_style.txt Fri Sep 17 16:23:51 2010 -0400 @@ -30,12 +30,12 @@ The four main documents describing our Python coding guidelines are: * `PEP 8 -- Style Guide for Python Code <http://www.python.org/dev/peps/pep-0008>`_ + * `Google Python Style Guide + <http://google-styleguide.googlecode.com/svn/trunk/pyguide.html>`_ * `PEP 257 -- Docstring Conventions <http://www.python.org/dev/peps/pep-0257>`_ * `Numpy Docstring Standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard>`_ - * `Google Python Style Guide - <http://google-styleguide.googlecode.com/svn/trunk/pyguide.html>`_ However, there are a few points mentioned in those documents that we decided @@ -49,7 +49,8 @@ .. code-block:: python # Good. - """This is a multi-line docstring. + """ + This is a multi-line docstring. Which means it has more than one line. """ @@ -308,6 +309,7 @@ if (cond_1 and cond_2 and cond_3): + ... # Bad. if cond_1 and \