diff options
| author | Stefan van der Walt <stefan@sun.ac.za> | 2009-06-22 10:19:16 +0000 |
|---|---|---|
| committer | Stefan van der Walt <stefan@sun.ac.za> | 2009-06-22 10:19:16 +0000 |
| commit | 077eec4b4f428d1de17ef8373f29618cdf5551b8 (patch) | |
| tree | 705fdb5df6c34b6dd44b6b6e589327ca9e5b109e /doc | |
| parent | 47b4791f4cef766f755d4eddb843b1d73fe3d1b0 (diff) | |
| download | numpy-077eec4b4f428d1de17ef8373f29618cdf5551b8.tar.gz | |
doctest: +SKIP may still be required.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HOWTO_DOCUMENT.txt | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/HOWTO_DOCUMENT.txt b/doc/HOWTO_DOCUMENT.txt index 029585648..64bacfbe8 100644 --- a/doc/HOWTO_DOCUMENT.txt +++ b/doc/HOWTO_DOCUMENT.txt @@ -321,9 +321,8 @@ The sections of the docstring are: $ nosetests --with-doctest example.py - To improve readability, do not use doctest-specific markup like - ``<BLANKLINE>`` or ``#doctest: +SKIP``, even if this causes the - example to fail. + It is not necessary to use the doctest markup ``<BLANKLINE>`` to + indicate empty lines in the output. The examples may assume that ``import numpy as np`` is executed before the example code in *numpy*, and ``import scipy as sp`` in *scipy*. |