docs: tweak the description of --concurrency

nedbat · Nov 27, 2021 · fbd3c71 · fbd3c71
1 parent fb7b0e5
commit fbd3c71
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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