text-wrapping; source code highlighting
authorDan Crosta <dcrosta@late.am>
Sat, 31 Dec 2011 00:53:47 +0000 (19:53 -0500)
committerDan Crosta <dcrosta@late.am>
Sat, 31 Dec 2011 00:54:09 +0000 (19:54 -0500)
docs/notes/styleguide.rst

index 33c804c..626d4a8 100644 (file)
@@ -61,10 +61,18 @@ Sub section headings::
     Very Deep
     ~~~~~~~~~
 
+Prose
+-----
+
+Wrap text lines at 78 characters. Where necessary, lines may exceed 78
+characters, especially if wrapping would make the source text more difficult
+to read.
+
+
 Code Examples
 -------------
 
-Wrap all code examples within 70 characters to avoid horizontal scrollbars.
+Wrap all code examples at 70 characters to avoid horizontal scrollbars.
 
 Command line examples::
 
@@ -79,12 +87,16 @@ Python interpreter examples::
 
     Label the example::
 
+    .. code-block:: python
+
         >>> import this
 
 Python examples::
 
     Descriptive title::
 
+    .. code-block:: python
+
         def get_answer():
             return 42