summaryrefslogtreecommitdiff
path: root/coverage/summary.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-05-15 23:03:52 -0400
committerNed Batchelder <ned@nedbatchelder.com>2010-05-15 23:03:52 -0400
commitf0b3451e829de7311c39a18c0fb34312330981ef (patch)
tree18d749a0434445f0316ecc7b641739b2796e268b /coverage/summary.py
parent4fb69b6c13c00bba910afe9d6beade673f4e4386 (diff)
downloadpython-coveragepy-git-f0b3451e829de7311c39a18c0fb34312330981ef.tar.gz
Format the code to pylint's liking, and fix up the docstrings for omit and include.
Diffstat (limited to 'coverage/summary.py')
-rw-r--r--coverage/summary.py11
1 files changed, 5 insertions, 6 deletions
diff --git a/coverage/summary.py b/coverage/summary.py
index df730375..89b31020 100644
--- a/coverage/summary.py
+++ b/coverage/summary.py
@@ -14,14 +14,13 @@ class SummaryReporter(Reporter):
self.show_missing = show_missing
self.branches = coverage.data.has_arcs()
- def report(self, morfs, omit_prefixes=None, outfile=None, include_prefixes=None):
+ def report(self, morfs, omit_prefixes=None, outfile=None,
+ include_prefixes=None
+ ):
"""Writes a report summarizing coverage statistics per module.
- `omit_prefixes` is a list of prefixes. CodeUnits that match those prefixes
- will be omitted from the list.
- `include_prefixes` is a list of prefixes. Only CodeUnits that match those prefixes
- will be included in the list.
- You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
+ See `coverage.report()` for other arguments.
+
"""
self.find_code_units(morfs, omit_prefixes, include_prefixes)