diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2011-09-17 09:19:52 -0600 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2011-09-17 09:19:52 -0600 |
commit | aded70c4d02eec7a347af9868f1691dc49310f4d (patch) | |
tree | 24af71956ebd7e4f42804279b101acd03c11fb02 /doc | |
parent | d6ccacad9815d56131f8148c23243f355008b75d (diff) | |
download | numpy-aded70c4d02eec7a347af9868f1691dc49310f4d.tar.gz |
STY: Fix spelling and reword text.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index eeeb50711..ee083c4fe 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -9,14 +9,14 @@ A Guide to NumPy/SciPy Documentation For an accompanying example, see `example.py <http://github.com/numpy/numpy/blob/master/doc/example.py>`_. - When using `Sphinx <http://sphinx.pocoo.org/>`_ in combination with the numpy - conventions, you may be interested in the ``numpydoc`` extension, which will - handle your docstrings correctly. For example, it will extract the - ``Parameters`` section from your docstring and convert this into a field list. - It can also help alleviate reStructuredText errors encounterde when using - plain sphinx. Sphinx gets confused because the numpy docstrings have section - headers (e.g. ``-------------``) which sphinx does not expect to find in - docstrings. + When using `Sphinx <http://sphinx.pocoo.org/>`_ in combination with the + numpy conventions, you should use the ``numpydoc`` extension so that your + docstrings will be handled correctly. For example, Sphinx will extract the + ``Parameters`` section from your docstring and convert it into a field + list. Using numpydoc will also avoid the reStructuredText errors produced + by plain Sphinx when it encounters numpy docstring conventions like + section headers (e.g. ``-------------``) that sphinx does not expect to + find in docstrings. It is available from: |