summaryrefslogtreecommitdiff
path: root/coverage/control.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2009-03-12 20:56:23 -0400
committerNed Batchelder <ned@nedbatchelder.com>2009-03-12 20:56:23 -0400
commit4b9a45174e54933df7acc851474ab53d5fc51941 (patch)
tree64560d89c33b77be8551fa382121728b70af3eae /coverage/control.py
parent1b6efa37ca6e4ba5d1fbae03b4582c1cf24b4b65 (diff)
downloadpython-coveragepy-git-4b9a45174e54933df7acc851474ab53d5fc51941.tar.gz
Add a docstring.
Diffstat (limited to 'coverage/control.py')
-rw-r--r--coverage/control.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/coverage/control.py b/coverage/control.py
index 4f3a3f57..cd1a515a 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -152,8 +152,13 @@ class coverage:
return (filename, statements, excluded, missing,
format_lines(statements, missing))
- # Programmatic entry point
def report(self, morfs, show_missing=True, ignore_errors=False, file=None):
+ """Write a summary report to `file`.
+
+ Each module in `morfs` is listed, with counts of statements, executed
+ statements, missing statements, and a list of lines missed.
+
+ """
reporter = SummaryReporter(self, show_missing, ignore_errors)
reporter.report(morfs, outfile=file)