summaryrefslogtreecommitdiff
path: root/coverage/results.py
diff options
context:
space:
mode:
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.
"""