summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-10-16 08:16:38 -0400
committerNed Batchelder <ned@nedbatchelder.com>2021-10-16 10:46:35 -0400
commit99cf3cbd331e03750e1a251d36d1849dc59b427e (patch)
treed71ea97f1488e19c3c6cb2d1851d5aec0a91cba0 /doc
parent702c927fed2b2120ed2e4aa66668170d4120ca30 (diff)
downloadpython-coveragepy-git-99cf3cbd331e03750e1a251d36d1849dc59b427e.tar.gz
feat: `coverage run` now sets the COVERAGE_RUN environment variable
Diffstat (limited to 'doc')
-rw-r--r--doc/cmd.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index b4bf41ab..1a54043d 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -137,6 +137,10 @@ If your coverage results seem to be overlooking code that you know has been
executed, try running coverage.py again with the ``--timid`` flag. This uses a
simpler but slower trace method, and might be needed in rare cases.
+Coverage.py sets an environment variable, ``COVERAGE_RUN`` to indicate that
+your code is running under coverage measurement. The value is not relevant,
+and may change in the future.
+
.. _cmd_warnings: