From 1b647fded9fbacb170b6b2932e1cf56e62c29c95 Mon Sep 17 00:00:00 2001 From: "FeRD (Frank Dana)" Date: Mon, 1 Dec 2025 20:34:37 -0500 Subject: [PATCH] Docs: Add caution about ranges like `py{39-314}` 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) --- docs/config.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index f65c970f0..bfd024be0 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -1688,6 +1688,13 @@ will create the following envs: Negative ranges will also be expanded (``{3-1}`` -> ``{3,2,1}``), however, open ranges such as ``{1-}``, ``{-2}``, ``{a-}``, and ``{-b}`` will not be expanded. +.. caution:: + + 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, + ``py39``, ``py40``, ``py41`` … ``py314``.) + Instead, use ``py3{9-14}``. Generative section names