From 44fbd3b02ad22326767dc37fe3b94aa93b36e8a3 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 27 Oct 2022 11:48:07 -0400 Subject: fix: in toml config, only apply environment substitution to coverage settings. #1481 --- doc/config.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/config.rst b/doc/config.rst index 0cb2cfa6..6b753579 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -31,10 +31,14 @@ Coverage.py will read settings from other usual configuration files if no other configuration file is used. It will automatically read from "setup.cfg" or "tox.ini" if they exist. In this case, the section names have "coverage:" prefixed, so the ``[run]`` options described below will be found in the -``[coverage:run]`` section of the file. If coverage.py is installed with the -``toml`` extra (``pip install coverage[toml]``), it will automatically read -from "pyproject.toml". Configuration must be within the ``[tool.coverage]`` -section, for example, ``[tool.coverage.run]``. +``[coverage:run]`` section of the file. + +Coverage.py will read from "pyproject.toml" if TOML support is available, +either because you are running on Python 3.11 or later, or because you +installed with the ``toml`` extra (``pip install coverage[toml]``). +Configuration must be within the ``[tool.coverage]`` section, for example, +``[tool.coverage.run]``. Environment variable expansion in values is +available, but only within quoted strings, even for non-string values. Syntax -- cgit v1.2.1