Properly document the tox_env_teardown hook (#3333)

tox-dev · Sep 7, 2024 · fab358e · fab358e
1 parent 8d0a47c
commit fab358e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/changelog/3305.doc.rst 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
@@ -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
     """