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

[numpy-svn at scipy.org]

Author: jarrod.millman
Date: 2008-01-22 00:14:05 -0600 (Tue, 22 Jan 2008)
New Revision: 4740

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
add more explanation for new standard


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-01-22 05:22:01 UTC (rev 4739)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-01-22 06:14:05 UTC (rev 4740)
@@ -4,10 +4,8 @@
 
 .. 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 it no longer follows the epydoc/restructured text standards.  This means 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:
+.. 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>`__
 
-`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: