Skip to content

Commit 1e9c3bc

Browse files
committed
Add a comment about multi-version local testing
Adds a comment about how to run tests locally on multiple versions of python. Ensures it is clear that it only works if particular version of python is installed on the users machine. Recommends `pytest` as a possible way to manage multiple local versions of python. Note the hyperlink out to `setup.cfg` is pinned to commit sha 1297c8c instead of pinning to main branch.
1 parent f01c2fc commit 1e9c3bc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/text/how_to_contribute.rst

+12
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,18 @@ you have to:
6767
pytest
6868
6969
70+
To test changes across multiple versions of Python, run:
71+
72+
73+
.. code::
74+
75+
tox -r
76+
77+
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.
79+
80+
A recommended way to manage multiple Python versions when testing locally is with `pyenv`, which enables organized installation and switching between versions.
81+
7082
Documentation
7183
'''''''''''''
7284

0 commit comments

Comments
 (0)