summaryrefslogtreecommitdiff
path: root/doc/source/dev/development_environment.rst
diff options
context:
space:
mode:
authorScott Sanderson <ssanderson@quantopian.com>2016-07-23 14:50:18 -0400
committerScott Sanderson <ssanderson@quantopian.com>2016-07-23 16:35:27 -0400
commit56d0c26903a28d8bc5de6c6ef313c23157159bb0 (patch)
treed1070adf1d887df4623cdc33af7c9927073e76b4 /doc/source/dev/development_environment.rst
parent93240e0d8ea23644a5b7874037e658c54966ff54 (diff)
downloadnumpy-56d0c26903a28d8bc5de6c6ef313c23157159bb0.tar.gz
DOC: Document extra args forwarding to nose.
This is useful for things like passing ``--pdb`` to make nose drop into a pdb post-mortem on exception.
Diffstat (limited to 'doc/source/dev/development_environment.rst')
-rw-r--r--doc/source/dev/development_environment.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index ed8ff5828..cbc4e2a46 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -32,6 +32,13 @@ This builds Numpy first, so the first time it may take a few minutes. If
you specify ``-n``, the tests are run against the version of NumPy (if
any) found on current PYTHONPATH.
+When specifying a target using ``-s``, ``-t``, or ``--python``, additional
+arguments may be forwarded to the target embedded by ``runtests.py`` by passing
+the extra arguments after a bare ``--``. For example, to run a test method with
+the ``--pdb`` flag forwarded to nose, run the following::
+
+ $ python runtests.py -t numpy/core/tests/test_ufunc.py:TestUfunc.test_sum -- --pdb
+
Using ``runtests.py`` is the recommended approach to running tests.
There are also a number of alternatives to it, for example in-place
build or installing to a virtualenv. See the FAQ below for details.