diff options
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 3192c7ed3..de0190084 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -13,11 +13,15 @@ A Guide to NumPy/SciPy Documentation 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 + 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. + Some features described in this document require a recent version of + ``numpydoc``. For example, the **Yields** section was added in + ``numpydoc`` 0.6. + It is available from: * `numpydoc on PyPI <http://pypi.python.org/pypi/numpydoc>`_ @@ -267,6 +271,9 @@ The sections of the docstring are: err_msg : str or None Human readable error message, or None on success. + Support for the **Yields** section was added in `numpydoc + <https://github.com/numpy/numpydoc>`_ version 0.6. + 7. **Other Parameters** An optional section used to describe infrequently used parameters. @@ -546,7 +553,8 @@ Documenting generators ---------------------- Generators should be documented just as functions are documented. The only difference is that one should use the **Yields** section instead -of the **Returns** section. +of the **Returns** section. Support for the **Yields** section was added in +`numpydoc <https://github.com/numpy/numpydoc>`_ version 0.6. Documenting constants |