summaryrefslogtreecommitdiff
path: root/coverage/annotate.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
commitfc920203f8ec8b87c331a9da091e82645a2e9b43 (patch)
treee7de67e634852f41259ef953b3b7041d88af0b5b /coverage/annotate.py
parent8951e029c5c96ede37c6bb82344d5029c1622575 (diff)
downloadpython-coveragepy-fc920203f8ec8b87c331a9da091e82645a2e9b43.tar.gz
Format the code to pylint's liking, and fix up the docstrings for omit and include.
Diffstat (limited to 'coverage/annotate.py')
-rw-r--r--coverage/annotate.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/coverage/annotate.py b/coverage/annotate.py
index b53ae03..5cbdd6a 100644
--- a/coverage/annotate.py
+++ b/coverage/annotate.py
@@ -33,15 +33,17 @@ class AnnotateReporter(Reporter):
blank_re = re.compile(r"\s*(#|$)")
else_re = re.compile(r"\s*else\s*:\s*(#|$)")
- def report(self, morfs, directory=None, omit_prefixes=None, include_prefixes=None):
+ def report(self, morfs, directory=None, omit_prefixes=None,
+ include_prefixes=None):
"""Run the report.
- `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 arguments.
+
"""
- self.report_files(self.annotate_file, morfs, directory, omit_prefixes, include_prefixes)
+ self.report_files(
+ self.annotate_file, morfs, directory, omit_prefixes,
+ include_prefixes
+ )
def annotate_file(self, cu, analysis):
"""Annotate a single file.