summaryrefslogtreecommitdiff
path: root/doc/help/annotate.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2020-07-24 22:08:29 -0400
committerNed Batchelder <ned@nedbatchelder.com>2020-07-24 22:08:29 -0400
commit348aa47798d5d315c11d568eb87165b857d547e6 (patch)
tree7b433ee26291b6ecbc52327f665937147c89aa10 /doc/help/annotate.rst
parent5a30c8d82aa942ce882fda8dbf16f5ec6f9608c4 (diff)
downloadpython-coveragepy-git-348aa47798d5d315c11d568eb87165b857d547e6.tar.gz
Help in docs didn't work with tmp
Diffstat (limited to 'doc/help/annotate.rst')
-rw-r--r--doc/help/annotate.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/help/annotate.rst b/doc/help/annotate.rst
new file mode 100644
index 00000000..fb80e12e
--- /dev/null
+++ b/doc/help/annotate.rst
@@ -0,0 +1,26 @@
+
+.. code::
+
+ $ coverage annotate --help
+ Usage: coverage annotate [options] [modules]
+
+ Make annotated copies of the given files, marking statements that are executed
+ with > and statements that are missed with !.
+
+ Options:
+ -d DIR, --directory=DIR
+ Write the output files to DIR.
+ -i, --ignore-errors Ignore errors while reading source files.
+ --include=PAT1,PAT2,...
+ Include only files whose paths match one of these
+ patterns. Accepts shell-style wildcards, which must be
+ quoted.
+ --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
+ Accepts shell-style wildcards, which must be quoted.
+ --debug=OPTS Debug options, separated by commas. [env:
+ COVERAGE_DEBUG]
+ -h, --help Get help on this command.
+ --rcfile=RCFILE Specify configuration file. By default '.coveragerc',
+ 'setup.cfg', 'tox.ini', and 'pyproject.toml' are
+ tried. [env: COVERAGE_RCFILE]
+