diff options
Diffstat (limited to 'numpy/doc')
| -rw-r--r-- | numpy/doc/HOWTO_DOCUMENT.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/numpy/doc/HOWTO_DOCUMENT.txt b/numpy/doc/HOWTO_DOCUMENT.txt index bb147068d..35c3b2f93 100644 --- a/numpy/doc/HOWTO_DOCUMENT.txt +++ b/numpy/doc/HOWTO_DOCUMENT.txt @@ -4,6 +4,15 @@ A Guide to NumPy/SciPy Documentation .. 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: |