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

numpy-svn at scipy.org numpy-svn at scipy.org
Sat Mar 15 14:25:18 EDT 2008


Author: charris
Date: 2008-03-15 13:25:15 -0500 (Sat, 15 Mar 2008)
New Revision: 4871

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Break lines.


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-03-14 16:17:44 UTC (rev 4870)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-03-15 18:25:15 UTC (rev 4871)
@@ -4,7 +4,17 @@
 
 .. 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
 --------




More information about the Numpy-svn mailing list