docs(config): Fix base_python default reference

The previous description of `{package_root}` doesn't make much sense because it doesn't have anything to do with Python versions. I'm guessing it was a copy and paste that wasn't updated. Change it to a value that tries to be both short and accurate matching the conventions observed in other options.
tox-dev · Nov 15, 2023 · 851886c · 851886c
1 parent 2e9e8b2
commit 851886c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/changelog/3156.doc.rst b/docs/changelog/3156.doc.rst
@@ -0,0 +1 @@
+Fix default value for ``base_python`` - by :user:`rpatterson`.
diff --git a/docs/config.rst b/docs/config.rst
@@ -530,7 +530,7 @@ Python options
 ~~~~~~~~~~~~~~
 .. conf::
    :keys: base_python, basepython
-   :default: {package_root}
+   :default: <{env_name} python factor> or <python version of tox>
 
    Name or path to a Python interpreter which will be used for creating the virtual environment, first one found wins.
    This determines in practice the Python for what we'll create a virtual isolated environment. Use this to specify the