Mercurial > pylearn

changeset 1514:97ec0d3248ca

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add info about Theano docstring and UTF-8
author Frederic Bastien <nouiz@nouiz.org>
date Tue, 29 Nov 2011 10:55:25 -0500
parents 2b3cff882382
children 1de26774035f
files doc/v2_planning/API_coding_style.txt
diffstat 1 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/v2_planning/API_coding_style.txt	Tue Sep 13 14:02:33 2011 -0400
+++ b/doc/v2_planning/API_coding_style.txt	Tue Nov 29 10:55:25 2011 -0500
@@ -715,6 +715,20 @@
         * Can make a system to put a comment to the ticket?
 
 
+Theano
+======
+
+Theano used many standard for its docstring. I think we should consentrate on the more frequent: http://sphinx.pocoo.org/markup/desc.html#info-field-lists.
+
+UTF-8
+=====
+
+To make a file UTF-8 compatible, just add this line at the begining of the file:
+
+.. code-block:: python
+
+    # -*- coding: utf-8 -*-
+
 TODO
 ====