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

[numpy-svn at scipy.org]

Author: jarrod.millman
Date: 2008-01-21 23:19:42 -0600 (Mon, 21 Jan 2008)
New Revision: 4738

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
explanation of current situation


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-01-21 17:02:06 UTC (rev 4737)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-01-22 05:19:42 UTC (rev 4738)
@@ -4,6 +4,15 @@
 
 .. 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:
+`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: