From 4b9a45174e54933df7acc851474ab53d5fc51941 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 12 Mar 2009 20:56:23 -0400 Subject: Add a docstring. --- coverage/control.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'coverage/control.py') 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) -- cgit v1.2.1