Skip to content

Commit fbd3c71

Browse files
committed
docs: tweak the description of --concurrency
1 parent fb7b0e5 commit fbd3c71

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

coverage/cmdline.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class Opts:
4444
'', '--concurrency', action='store', metavar="LIBS",
4545
help=(
4646
"Properly measure code using a concurrency library. " +
47-
"Valid values are: {}."
47+
"Valid values are: {}, or a comma-list of them."
4848
).format(", ".join(sorted(CoverageConfig.CONCURRENCY_CHOICES))),
4949
)
5050
context = optparse.make_option(

doc/cmd.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ There are many options:
126126
coverage.
127127
--concurrency=LIBS Properly measure code using a concurrency library.
128128
Valid values are: eventlet, gevent, greenlet,
129-
multiprocessing, thread.
129+
multiprocessing, thread, or a comma-list of them.
130130
--context=LABEL The context label to record for this coverage run.
131131
--include=PAT1,PAT2,...
132132
Include only files whose paths match one of these
@@ -152,7 +152,7 @@ There are many options:
152152
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
153153
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
154154
tried. [env: COVERAGE_RCFILE]
155-
.. [[[end]]] (checksum: 072cccad7f8ad3e7b72c266305ef5e4a)
155+
.. [[[end]]] (checksum: bf76ace21288ca9d3c558ccd5fb82b08)
156156
157157
If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
158158
flag. Otherwise only statement coverage is measured.

doc/python-coverage.1.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,10 @@ COMMAND REFERENCE
288288
\--branch
289289
Measure branch coverage in addition to statement coverage.
290290

291-
\--concurrency `LIB`
291+
\--concurrency `LIBS`
292292
Properly measure code using a concurrency library. Valid values are:
293-
thread, gevent, greenlet, eventlet, multiprocessing.
293+
thread, gevent, greenlet, eventlet, multiprocessing, or a comma-list of
294+
them.
294295

295296
\--context `CONTEXT`
296297
The context label to record for this coverage run.

howto.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
- Version of latest stable release in doc/index.rst
1919
- Version, release, release_date and copyright date in doc/conf.py
2020
- Look for CHANGEME comments
21+
- Make sure the docs are cogged:
22+
$ make cogdoc
2123
- Don't forget the man page: doc/python-coverage.1.txt
2224
- Check that the docs build correctly:
2325
$ tox -e doc

0 commit comments

Comments
 (0)