summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2017-03-05 08:04:02 -0500
committerNed Batchelder <ned@nedbatchelder.com>2017-03-05 08:04:02 -0500
commitcc8410b03041246abf2b68f88c30ae3d4d848854 (patch)
tree7d71227932b697af25fd70a04aed79898d774f2a
parente0b3571b6565be4fa546779aca237d97344451f1 (diff)
downloadpython-coveragepy-cc8410b03041246abf2b68f88c30ae3d4d848854.tar.gz
More docstring.
-rw-r--r--coverage/results.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/coverage/results.py b/coverage/results.py
index 1ca55e8..963ad8b 100644
--- a/coverage/results.py
+++ b/coverage/results.py
@@ -274,6 +274,9 @@ class Numbers(SimpleRepr):
def should_fail_under(cov, total):
"""Determine if a total should fail due to fail-under.
+ `cov` is a Coverage instance, `total` is a float, the coverage measurement
+ total.
+
Returns True if the total should fail.
"""