From 27f02b91eb244d59d897f0a3ae5362cfe8afe2b9 Mon Sep 17 00:00:00 2001 From: Scott-Simmons <52365471+Scott-Simmons@users.noreply.github.com> Date: Fri, 15 Nov 2024 08:47:57 +1100 Subject: [PATCH] Documentation updates Change docs to reflect the new testing invokations. --- docs/text/how_to_contribute.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/text/how_to_contribute.rst b/docs/text/how_to_contribute.rst index 0633784f..a5108eec 100644 --- a/docs/text/how_to_contribute.rst +++ b/docs/text/how_to_contribute.rst @@ -64,7 +64,7 @@ you have to: .. code:: - pytest + make test-local To test changes across multiple versions of Python, run: @@ -72,13 +72,24 @@ To test changes across multiple versions of Python, run: .. code:: - tox -r + make test-all-local -`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. +This 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. +In addition to running tests locally, you can also run them in a Dockerized testing environment: + + +.. code:: + + make test-all-testenv + + +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. + + Documentation '''''''''''''