summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2022-12-14 18:32:56 -0500
committerGitHub <noreply@github.com>2022-12-14 18:32:56 -0500
commit32d616224e8342a77e57a2d9d135981de5e6ea67 (patch)
tree9b3ab7f10f0a563732ee5ea7c94ee4c39088170d
parent586eb35b67a884b7193fae4ec20975c420c2b354 (diff)
parentdb3a1fd680c8975cb08ba621e5c3652c0c1fe164 (diff)
downloadnumpy-32d616224e8342a77e57a2d9d135981de5e6ea67.tar.gz
Merge pull request #22800 from ngoldbaum/testing-docs-fix
DOC: mention installing test dependencies in testing instructions
-rw-r--r--doc/source/dev/development_environment.rst4
-rw-r--r--doc/source/dev/index.rst2
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index 0ac02271d..b5ee915c4 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -27,6 +27,10 @@ of this chapter we assume that you have set up your git repo as described in
Testing builds
--------------
+Before running the tests, first install the test dependencies::
+
+ $ python -m pip install -r test_requirements.txt
+
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::
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
index 93b57f7e2..55f5ce99a 100644
--- a/doc/source/dev/index.rst
+++ b/doc/source/dev/index.rst
@@ -210,7 +210,7 @@ Running NumPy's test suite locally requires some additional packages, such as
in ``test_requirements.txt`` in the top-level directory, and can conveniently
be installed with::
- pip install -r test_requirements.txt
+ $ python -m pip install -r test_requirements.txt
Tests for a module should ideally cover all code in that module,
i.e., statement coverage should be at 100%.