Docs: Add caution about ranges like py{39-314}
#3652
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tox's ultra-concise environment naming creates some challenges when
using features like range expansions. If the user tries to define
a range like `py{39-314}`, they'll get a lot more than they bargained
for. Add a "Caution" box to the documentation about the range feature,
reminding users to consider what their ranges mean _numerically_,
rather than semantically.
Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>
gaborbernat
approved these changes
Dec 4, 2025
ferdnyc
commented
Dec 5, 2025
|
|
||
| Be conscious of the number of significant digits in your range endpoints. | ||
| A range like ``py{39-314}`` will not do what you may expect. | ||
| (It expands to 275 environment names, |
Contributor
Author
There was a problem hiding this comment.
It's gonna bug me that that should've been 276. 🙄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A very minor documentation addition.
Tox's ultra-concise environment naming creates some challenges when using features like range expansions. If the user tries to define a range like
py{39-314}, they'll get a lot more than they bargained for. Add a "Caution" box to the documentation about the range feature, reminding users to consider what their ranges mean numerically, rather than semantically.tox -e fix)docs/changelogfolder