diff --git a/docs/changelog/3305.doc.rst b/docs/changelog/3305.doc.rst new file mode 100644 index 0000000000..7e1608a0db --- /dev/null +++ b/docs/changelog/3305.doc.rst @@ -0,0 +1 @@ +Changes the ``tox_env_teardown`` docstring to explain the hook is called after a tox env was teared down. diff --git a/src/tox/plugin/spec.py b/src/tox/plugin/spec.py index 742baa5352..54b76ddc45 100644 --- a/src/tox/plugin/spec.py +++ b/src/tox/plugin/spec.py @@ -94,7 +94,7 @@ def tox_on_install(tox_env: ToxEnv, arguments: Any, section: str, of_type: str) @_spec def tox_env_teardown(tox_env: ToxEnv) -> None: # noqa: ARG001 """ - Called before executing an installation command. + Called after a tox environment has been teared down. :param tox_env: the tox environment """