summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-11-26 19:09:36 -0500
committerNed Batchelder <ned@nedbatchelder.com>2021-11-26 19:09:36 -0500
commitfbd3c71eca4e660125769ff61d468963ce699440 (patch)
treee401c17b8b7c6d9f8a75a63bbf8983625b7ac035
parentfb7b0e5b90bd2213255a66c26e258612c9784827 (diff)
downloadpython-coveragepy-git-fbd3c71eca4e660125769ff61d468963ce699440.tar.gz
docs: tweak the description of --concurrency
-rw-r--r--coverage/cmdline.py2
-rw-r--r--doc/cmd.rst4
-rw-r--r--doc/python-coverage.1.txt5
-rw-r--r--howto.txt2
4 files changed, 8 insertions, 5 deletions
diff --git a/coverage/cmdline.py b/coverage/cmdline.py
index ec809330..002a8e44 100644
--- a/coverage/cmdline.py
+++ b/coverage/cmdline.py
@@ -44,7 +44,7 @@ class Opts:
'', '--concurrency', action='store', metavar="LIBS",
help=(
"Properly measure code using a concurrency library. " +
- "Valid values are: {}."
+ "Valid values are: {}, or a comma-list of them."
).format(", ".join(sorted(CoverageConfig.CONCURRENCY_CHOICES))),
)
context = optparse.make_option(
diff --git a/doc/cmd.rst b/doc/cmd.rst
index 3b1c51cf..76ef9dbf 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -126,7 +126,7 @@ There are many options:
coverage.
--concurrency=LIBS Properly measure code using a concurrency library.
Valid values are: eventlet, gevent, greenlet,
- multiprocessing, thread.
+ multiprocessing, thread, or a comma-list of them.
--context=LABEL The context label to record for this coverage run.
--include=PAT1,PAT2,...
Include only files whose paths match one of these
@@ -152,7 +152,7 @@ There are many options:
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-.. [[[end]]] (checksum: 072cccad7f8ad3e7b72c266305ef5e4a)
+.. [[[end]]] (checksum: bf76ace21288ca9d3c558ccd5fb82b08)
If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
flag. Otherwise only statement coverage is measured.
diff --git a/doc/python-coverage.1.txt b/doc/python-coverage.1.txt
index b854b460..bffc7072 100644
--- a/doc/python-coverage.1.txt
+++ b/doc/python-coverage.1.txt
@@ -288,9 +288,10 @@ COMMAND REFERENCE
\--branch
Measure branch coverage in addition to statement coverage.
- \--concurrency `LIB`
+ \--concurrency `LIBS`
Properly measure code using a concurrency library. Valid values are:
- thread, gevent, greenlet, eventlet, multiprocessing.
+ thread, gevent, greenlet, eventlet, multiprocessing, or a comma-list of
+ them.
\--context `CONTEXT`
The context label to record for this coverage run.
diff --git a/howto.txt b/howto.txt
index 282bbda9..a3784352 100644
--- a/howto.txt
+++ b/howto.txt
@@ -18,6 +18,8 @@
- Version of latest stable release in doc/index.rst
- Version, release, release_date and copyright date in doc/conf.py
- Look for CHANGEME comments
+ - Make sure the docs are cogged:
+ $ make cogdoc
- Don't forget the man page: doc/python-coverage.1.txt
- Check that the docs build correctly:
$ tox -e doc