Skip to content

Add a "version added" note for tox_extend_envs #3595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2025
Merged

Add a "version added" note for tox_extend_envs #3595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/tox/plugin/spec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ def tox_register_tox_env(register: ToxEnvRegister) -> None:
def tox_extend_envs() -> Iterable[str]:
"""Declare additional environment names.

.. versionadded:: 4.29.0
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I wasn't sure whether it's better to have it at the end of the section or here. I opted for the beginning but lmk if I should move it.

Here's what it looks like — https://tox--3595.org.readthedocs.build/en/3595/plugins.html#tox.plugin.spec.tox_extend_envs.


This hook is called without any arguments early in the lifecycle. It
is expected to return an iterable of strings with environment names
for tox to consider. It can be used to facilitate dynamic creation of
Expand Down