Skip to content

Commit 27f02b9

Browse files
committed
Documentation updates
Change docs to reflect the new testing invokations.
1 parent aed52b7 commit 27f02b9

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/text/how_to_contribute.rst

+14-3
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,32 @@ you have to:
6464

6565
.. code::
6666
67-
pytest
67+
make test-local
6868
6969
7070
To test changes across multiple versions of Python, run:
7171

7272

7373
.. code::
7474
75-
tox -r
75+
make test-all-local
7676
7777
78-
`tox -r` will execute tests for the Python versions specified in `setup.cfg <https://github.com/blue-yonder/tsfresh/blob/1297c8ca5bd6f8f23b4de50e3f052fb4ec1307f8/setup.cfg>`_ using the `envlist` variable. For example, if `envlist` is set to `py37, py38`, the test suite will run for Python 3.7 and 3.8 on the local development platform, assuming the binaries for those versions are available locally. The exact Python microversions (e.g. `3.7.1` vs `3.7.2`) depend on what is installed on the local development machine.
78+
This will execute tests for the Python versions specified in `setup.cfg <https://github.com/blue-yonder/tsfresh/blob/1297c8ca5bd6f8f23b4de50e3f052fb4ec1307f8/setup.cfg>`_ using the `envlist` variable. For example, if `envlist` is set to `py37, py38`, the test suite will run for Python 3.7 and 3.8 on the local development platform, assuming the binaries for those versions are available locally. The exact Python microversions (e.g. `3.7.1` vs `3.7.2`) depend on what is installed on the local development machine.
7979

8080
A recommended way to manage multiple Python versions when testing locally is with `pyenv`, which enables organized installation and switching between versions.
8181

82+
In addition to running tests locally, you can also run them in a Dockerized testing environment:
83+
84+
85+
.. code::
86+
87+
make test-all-testenv
88+
89+
90+
This command will initially take some time. However subsequent invokations will be faster, and testing this way ensures a clean, consistent test environment, regardless of your local setup.
91+
92+
8293
Documentation
8394
'''''''''''''
8495

0 commit comments

Comments
 (0)