diff --git a/docs/text/how_to_contribute.rst b/docs/text/how_to_contribute.rst index a6a5cdc6..0633784f 100644 --- a/docs/text/how_to_contribute.rst +++ b/docs/text/how_to_contribute.rst @@ -67,6 +67,18 @@ you have to: pytest +To test changes across multiple versions of Python, run: + + +.. code:: + + tox -r + + +`tox -r` will execute tests for the Python versions specified in `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. + +A recommended way to manage multiple Python versions when testing locally is with `pyenv`, which enables organized installation and switching between versions. + Documentation '''''''''''''