Skip to content

Properly document the tox_env_teardown hook#3333

Merged
gaborbernat merged 2 commits intotox-dev:mainfrom
kemzeb:fix-docs
Sep 7, 2024
Merged

Properly document the tox_env_teardown hook#3333
gaborbernat merged 2 commits intotox-dev:mainfrom
kemzeb:fix-docs

Conversation

@kemzeb
Copy link
Contributor

@kemzeb kemzeb commented Aug 23, 2024

Previously the description from the tox_on_install hook was accidentally copied over to the tox_env_teardown hook.

Fixes #3305.

@gaborbernat gaborbernat merged commit fab358e into tox-dev:main Sep 7, 2024
@kemzeb kemzeb deleted the fix-docs branch September 7, 2024 05:26
hofbi referenced this pull request in luminartech/dev-tools Sep 13, 2024
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [tox](https://redirect.github.com/tox-dev/tox)
([changelog](https://tox.wiki/en/latest/changelog.html)) | `==4.18.0` ->
`==4.18.1` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/tox/4.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/tox/4.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/tox/4.18.0/4.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/tox/4.18.0/4.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>tox-dev/tox (tox)</summary>

###
[`v4.18.1`](https://redirect.github.com/tox-dev/tox/releases/tag/4.18.1)

[Compare
Source](https://redirect.github.com/tox-dev/tox/compare/4.18.0...4.18.1)

<!-- Release notes generated using configuration in .github/release.yml
at 4.18.1 -->

#### What's Changed

- Fixup the spec string for sys.executable by
[@&#8203;hroncok](https://redirect.github.com/hroncok) in
[https://github.com/tox-dev/tox/pull/3327](https://redirect.github.com/tox-dev/tox/pull/3327)
- Fix issue link in changelog by
[@&#8203;schlamar](https://redirect.github.com/schlamar) in
[https://github.com/tox-dev/tox/pull/3332](https://redirect.github.com/tox-dev/tox/pull/3332)
- Properly document the `tox_env_teardown` hook by
[@&#8203;kemzeb](https://redirect.github.com/kemzeb) in
[https://github.com/tox-dev/tox/pull/3333](https://redirect.github.com/tox-dev/tox/pull/3333)
- Add 3.13 to CI and bump deps by
[@&#8203;gaborbernat](https://redirect.github.com/gaborbernat) in
[https://github.com/tox-dev/tox/pull/3339](https://redirect.github.com/tox-dev/tox/pull/3339)

#### New Contributors

- [@&#8203;schlamar](https://redirect.github.com/schlamar) made their
first contribution in
[https://github.com/tox-dev/tox/pull/3332](https://redirect.github.com/tox-dev/tox/pull/3332)
- [@&#8203;kemzeb](https://redirect.github.com/kemzeb) made their first
contribution in
[https://github.com/tox-dev/tox/pull/3333](https://redirect.github.com/tox-dev/tox/pull/3333)

**Full Changelog**:
tox-dev/tox@4.18.0...4.18.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am on the first day of the
month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/luminartech/dev-tools).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC43NC4xIiwidXBkYXRlZEluVmVyIjoiMzguNzQuMSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] The explanation/docstring in tox_env_teardown is the same as for tox_on_install

2 participants