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 | 4b9a45174e54933df7acc851474ab53d5fc51941 (patch) | |
tree | 64560d89c33b77be8551fa382121728b70af3eae | |
parent | 1b6efa37ca6e4ba5d1fbae03b4582c1cf24b4b65 (diff) | |
download | python-coveragepy-git-4b9a45174e54933df7acc851474ab53d5fc51941.tar.gz |
Add a docstring.
-rw-r--r-- | CHANGES | 7 | ||||
-rw-r--r-- | coverage/control.py | 7 |
2 files changed, 13 insertions, 1 deletions
@@ -2,6 +2,13 @@ CHANGE HISTORY for coverage.py
------------------------------
+Version 3.0b2
+-------------
+
+Continued refactoring.
+
+-
+
Version 3.0b1
-------------
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) |