summaryrefslogtreecommitdiff
path: root/coverage/results.py
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
commit05d295b8ec8628c252ed591f7f4cc6c1cf7f2ca1 (patch)
treee98cded97140d3b41b4147664be78dc313858297 /coverage/results.py
parentd150179c75475d12a9c6ce01564a2ba9ea474d93 (diff)
downloadpython-coveragepy-git-05d295b8ec8628c252ed591f7f4cc6c1cf7f2ca1.tar.gz
More docstring.
Diffstat (limited to 'coverage/results.py')
-rw-r--r--coverage/results.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/coverage/results.py b/coverage/results.py
index 1ca55e87..963ad8b3 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.
"""