From fab358ebd4204183044c94d14a7f94eb724d89d5 Mon Sep 17 00:00:00 2001 From: Kemal Zebari <60799661+kemzeb@users.noreply.github.com> Date: Fri, 6 Sep 2024 22:03:47 -0700 Subject: [PATCH] Properly document the `tox_env_teardown` hook (#3333) --- docs/changelog/3305.doc.rst | 1 + src/tox/plugin/spec.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/changelog/3305.doc.rst diff --git a/docs/changelog/3305.doc.rst b/docs/changelog/3305.doc.rst new file mode 100644 index 000000000..7e1608a0d --- /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 742baa535..54b76ddc4 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 """