Mercurial > pylearn

diff doc/v2_planning/API_coding_style.txt @ 1183:bc1b445e22fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
API_coding_style: Added code example to explain the point about the number of spaces after a period
author Olivier Delalleau <delallea@iro>
date Fri, 17 Sep 2010 16:51:09 -0400
parents 9ebd40d31a1b
children 5783948b3f8c
line wrap: on
line diff
--- a/doc/v2_planning/API_coding_style.txt	Fri Sep 17 16:41:51 2010 -0400
+++ b/doc/v2_planning/API_coding_style.txt	Fri Sep 17 16:51:09 2010 -0400
@@ -43,6 +43,13 @@
 
     * Use only one space (not two) after a sentence-ending period in comments.
 
+      .. code-block:: python
+
+        # Good.
+        # This is the first sentence. It is followed by a single blank space.
+        # Bad.
+        # This is the first sentence.  It is followed by two blank spaces.
+
     * You do not need to add an extra blank line before the closing quotes of
       a multi-line docstring. Also, we ask that the first line of a multi-line
       docstring should contain only the opening quotes.