diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2009-03-12 20:56:23 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-03-12 20:56:23 -0400 |
commit | 59d44f7978d565fee81bd34b9a721fcc521f583d (patch) | |
tree | cf0be395e21ec69cf8b869b6c2b299fa09275457 /coverage/control.py | |
parent | d56b742676743743a7cdfce980f980ea3e3d1857 (diff) | |
download | python-coveragepy-59d44f7978d565fee81bd34b9a721fcc521f583d.tar.gz |
Add a docstring.
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/coverage/control.py b/coverage/control.py index 4f3a3f5..cd1a515 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) |