Mercurial > pylearn

changeset 1074:ee7f34fc98fe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merged
author Olivier Delalleau <delallea@iro>
date Fri, 10 Sep 2010 11:38:40 -0400
parents 3e7978201ffc (current diff) 04bbf05d249c (diff)
children d422f726c156
files doc/v2_planning/coding_style.txt
diffstat 1 files changed, 14 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/doc/v2_planning/coding_style.txt	Fri Sep 10 11:37:36 2010 -0400
+++ b/doc/v2_planning/coding_style.txt	Fri Sep 10 11:38:40 2010 -0400
@@ -8,12 +8,20 @@
 - David
 - Olivier D [leader]
 
+
+
+Fred: This is a refactored thing from James email of what we should put in message
+that we send to the user:
+1) Hint where in the code this log come from.
+2) Hint how to hide this message? or we should this into documentation.
+3) Tell explicitly if the user can ignore it and the consequence.
+
 Existing Python coding style specifications and guidelines
 ----------------------------------------------------------
 
-    * http://www.python.org/dev/peps/pep-0008/
-    * http://www.python.org/dev/peps/pep-0257/
-    * http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
+    * http://www.python.org/dev/peps/pep-0008/ Style Guide for Python Code
+    * http://www.python.org/dev/peps/pep-0257/ Docstring Conventions 
+    * http://google-styleguide.googlecode.com/svn/trunk/pyguide.html Google Python Style Guide
     * http://www.voidspace.org.uk/python/articles/python_style_guide.shtml
     * http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
     * http://www.cs.caltech.edu/courses/cs11/material/python/misc/python_style_guide.html
@@ -87,6 +95,8 @@
                 a, b, c, d, e, f)
           --> Probably depends on the specific situation, but we could have a
             few typical examples (and the same happens with multi-lines lists)
+	  (Fred: I would do 2 or 3, but not 1. I find it more redable when the
+	         indent is broken after a paranthesis then at any point.
 
     * From PEP 257: The BDFL [3] recommends inserting a blank line between the
       last paragraph in a multi-line docstring and its closing quotes, placing
@@ -122,7 +132,7 @@
    * Documentation
 Use RST with Sphinx.
 Task: Provide specific examples on how to document a class, method, and some
-specific classes like Op (DE).
+specific classes like Op (DE). Modify the theano documentation to include that.
 
    * Python versions to be supported
 Support 2.4 (because some of the clusters are still running 2.4) and write