Skip to content

Commit

Permalink
Properly document the tox_env_teardown hook (#3333)
Browse files Browse the repository at this point in the history
  • Loading branch information
kemzeb authored Sep 7, 2024
1 parent 8d0a47c commit fab358e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/changelog/3305.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Changes the ``tox_env_teardown`` docstring to explain the hook is called after a tox env was teared down.
2 changes: 1 addition & 1 deletion src/tox/plugin/spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down

0 comments on commit fab358e

Please sign in to comment.