diff options
Diffstat (limited to 'doc/source/reference/routines.rst')
| -rw-r--r-- | doc/source/reference/routines.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/reference/routines.rst b/doc/source/reference/routines.rst index 90fe1c189..0788d3a0a 100644 --- a/doc/source/reference/routines.rst +++ b/doc/source/reference/routines.rst @@ -2,6 +2,16 @@ Routines ******** +In this chapter routine docstrings are presented, grouped by functionality. +Many docstrings contain example code, which demonstrates basic usage +of the routine. The examples assume that NumPy is imported with:: + + >>> import numpy as np + +A convenient way to execute examples is the ``%doctest_mode`` mode of +IPython, which allows for pasting of multi-line examples and preserves +indentation. + .. toctree:: :maxdepth: 2 |