summaryrefslogtreecommitdiff
path: root/doc/cmd.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2022-01-15 17:16:46 -0500
committerNed Batchelder <ned@nedbatchelder.com>2022-01-15 17:16:46 -0500
commite52d616a065da649494f37112cadfde0c646a0b9 (patch)
treeda40e7dc03b021d1480c55c35368a83f97842096 /doc/cmd.rst
parent0b907fe3fb2eececbec16dccc17aeabb9c64dc15 (diff)
downloadpython-coveragepy-git-e52d616a065da649494f37112cadfde0c646a0b9.tar.gz
build: provide hints about how to fix cog-check quality failures.
Diffstat (limited to 'doc/cmd.rst')
-rw-r--r--doc/cmd.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index ed86e28a..a26aa8ac 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -1,6 +1,10 @@
.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
+.. This file is meant to be processed with cog to insert the latest command
+ help into the docs. If it's out of date, the quality checks will fail.
+ Running "make prebuild" will bring it up to date.
+
.. [[[cog
import contextlib
import io