summaryrefslogtreecommitdiff
path: root/doc/source/dev
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2019-08-08 15:54:58 +0300
committerGitHub <noreply@github.com>2019-08-08 15:54:58 +0300
commit3a2ab2d39f82171c99e78634cfb1014fda06245d (patch)
tree269b17994b7728c1adf6ff8838e7fb1fbdc5608e /doc/source/dev
parent24bc2daee52421b734f8f1cef176ba2360e2b4ea (diff)
parentc0225858d12cc50b257f63536d2ae1a05816b94b (diff)
downloadnumpy-3a2ab2d39f82171c99e78634cfb1014fda06245d.tar.gz
Merge pull request #14069 from sameshl/doc_test_instructions
DOC: Emphasize the need to run tests when building from source
Diffstat (limited to 'doc/source/dev')
-rw-r--r--doc/source/dev/development_environment.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index 340f22026..ce571926e 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -19,6 +19,11 @@ sources needs some additional steps, which are explained below. For the rest
of this chapter we assume that you have set up your git repo as described in
:ref:`using-git`.
+.. _testing-builds:
+
+Testing builds
+--------------
+
To build the development version of NumPy and run tests, spawn
interactive shells with the Python import paths properly set up etc.,
do one of::
@@ -47,6 +52,10 @@ When using pytest as a target (the default), you can
$ python runtests.py -v -t numpy/core/tests/test_multiarray.py -- -k "MatMul and not vector"
+.. note::
+
+ Remember that all tests of NumPy should pass before commiting your changes.
+
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.