summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2011-12-14 19:07:49 -0500
committerNed Batchelder <ned@nedbatchelder.com>2011-12-14 19:07:49 -0500
commitef4a73a9b97c5904c6e6fa886e321d1fd8a09566 (patch)
tree2b9fb563fed3adc8614817b1fb0b5515c2ee8404
parentf3d8851e095fd502fa0fcec58de5c3f22e88cd46 (diff)
downloadpython-coveragepy-ef4a73a9b97c5904c6e6fa886e321d1fd8a09566.tar.gz
Guido pointed out that these docs were wrong.
-rw-r--r--doc/branch.rst5
-rw-r--r--doc/excluding.rst2
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/branch.rst b/doc/branch.rst
index d9b6162..3ee09aa 100644
--- a/doc/branch.rst
+++ b/doc/branch.rst
@@ -7,6 +7,7 @@ Branch coverage measurement
:history: 20091127T201300, new for version 3.2
:history: 20100725T211700, updated for 3.4.
:history: 20110604T181700, updated for 3.5.
+:history: 20111214T181800, Fix a bug that Guido pointed out.
.. highlight:: python
:linenothreshold: 5
@@ -109,12 +110,12 @@ tell coverage.py that you don't want them flagged by marking them with a
pragma::
i = 0
- while i < 999999999: # pragma: no partial
+ while i < 999999999: # pragma: no branch
if eventually():
break
Here the while loop will never complete because the break will always be taken
at some point. Coverage.py can't work that out on its own, but the
-"no partial" pragma indicates that the branch is known to be partial, and
+"no branch" pragma indicates that the branch is known to be partial, and
the line is not flagged.
diff --git a/doc/excluding.rst b/doc/excluding.rst
index 9a3b5e7..f1262c3 100644
--- a/doc/excluding.rst
+++ b/doc/excluding.rst
@@ -94,7 +94,7 @@ Note that when using the ``exclude_lines`` option in a configuration file, you
are taking control of the entire list of regexes, so you need to re-specify the
default "pragma: no cover" match if you still want it to apply.
-A similar pragma, "no partial", can be used to tailor branch coverage
+A similar pragma, "no branch", can be used to tailor branch coverage
measurement. See :ref:`branch` for details.