Mercurial > pylearn

comparison doc/v2_planning/API_coding_style.txt @ 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
comparison
equal deleted inserted replaced
1513:2b3cff882382 1514:97ec0d3248ca
713 * Can make a system to change the ticket? 713 * Can make a system to change the ticket?
714 * When referencing a ticket, start the message with "Refs #abc" 714 * When referencing a ticket, start the message with "Refs #abc"
715 * Can make a system to put a comment to the ticket? 715 * Can make a system to put a comment to the ticket?
716 716
717 717
718 Theano
719 ======
720
721 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.
722
723 UTF-8
724 =====
725
726 To make a file UTF-8 compatible, just add this line at the begining of the file:
727
728 .. code-block:: python
729
730 # -*- coding: utf-8 -*-
731
718 TODO 732 TODO
719 ==== 733 ====
720 734
721 Things still missing from this document, being discussed in coding_style.txt: 735 Things still missing from this document, being discussed in coding_style.txt:
722 - Proper style for C code 736 - Proper style for C code