[Numpy-svn] r4936 - trunk/numpy/doc

numpy-svn at scipy.org numpy-svn at scipy.org
Sun Mar 23 10:21:36 EDT 2008


Author: stefan
Date: 2008-03-23 09:21:31 -0500 (Sun, 23 Mar 2008)
New Revision: 4936

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Fix ReST syntax in HOWTO_DOCUMENT.


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-03-23 13:53:33 UTC (rev 4935)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-03-23 14:21:31 UTC (rev 4936)
@@ -4,18 +4,21 @@
 
 .. Contents::
 
-.. Attention:: This document is slightly out of date.  During the December
-2007 sprint, Travis Oliphant made some changes to the NumPy/SciPy docstring
-standard.  The changes are relatively minor, but the standard no longer
-follows the epydoc/restructured text standards.  The changes brings our
-docstring standard more in line with the ETS standard; in addition, it also
-conserves horizontal real-estate and arguably looks better when printed as
-plain text.  Unfortunately, these changes mean that currently it isn't
-possible to render the docstrings as desired.  Travis has committed to writing
-something to render the docstrings.  At that point, we will update this
-document to correspond with the new standard.  For now, just refer to:
-`example.py <http://svn.scipy.org/svn/numpy/trunk/numpy/doc/example.py>`__
+.. Attention::
 
+  This document is slightly out of date.  During the December 2007 sprint,
+  Travis Oliphant made some changes to the NumPy/SciPy docstring standard.
+  The changes are relatively minor, but the standard no longer follows the
+  epydoc/restructured text standards.  The changes brings our docstring
+  standard more in line with the ETS standard; in addition, it also
+  conserves horizontal real-estate and arguably looks better when printed as
+  plain text.  Unfortunately, these changes mean that currently it isn't
+  possible to render the docstrings as desired.  Travis has committed to
+  writing something to render the docstrings.  At that point, we will update
+  this document to correspond with the new standard.  For now, just refer
+  to: `example.py
+  <http://svn.scipy.org/svn/numpy/trunk/numpy/doc/example.py>`__
+
 Overview
 --------
 In general, we follow the standard Python style conventions as described here:




More information about the Numpy-svn mailing list