summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2019-09-06 13:54:10 -0400
committerNed Batchelder <ned@nedbatchelder.com>2019-09-06 13:54:10 -0400
commit0b27364b24aabbaf52dff3ad4842ec07971f9adb (patch)
treea5873ac412ab8aed77f02f62b4e110b8d8fc6e3c
parentd9bc47d0db97ea47ebbe1b775947049792e8aa00 (diff)
downloadpython-coveragepy-git-0b27364b24aabbaf52dff3ad4842ec07971f9adb.tar.gz
Clarify some docs
-rw-r--r--doc/cmd.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index 25a9dd20..bffa147c 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -92,6 +92,12 @@ Python ``-m`` switch::
$ coverage run -m packagename.modulename arg1 arg2
blah blah ..your program's output.. blah blah
+.. note::
+
+ In most cases, the program to use here is a test runner, not your program
+ you are trying to measure. The test runner will run your tests and coverage
+ will measure the coverage of your code along the way.
+
If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
flag. Otherwise only statement coverage is measured.