diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2015-07-03 14:00:37 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-07-03 14:00:37 -0400 |
commit | 94287179f87bb02dbf4c189ad52f7416b4dc83f1 (patch) | |
tree | c68e93ef4341551146035153e8182aa0abd420bd /coverage/collector.py | |
parent | 17b2aef45c916bc6b50ed0ea6a6ed405178118f1 (diff) | |
download | python-coveragepy-94287179f87bb02dbf4c189ad52f7416b4dc83f1.tar.gz |
Add some docstrings
Diffstat (limited to 'coverage/collector.py')
-rw-r--r-- | coverage/collector.py | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/coverage/collector.py b/coverage/collector.py index 3f557aa..57c3560 100644 --- a/coverage/collector.py +++ b/coverage/collector.py @@ -129,10 +129,12 @@ class Collector(object): def reset(self): """Clear collected data, and prepare to collect more.""" - # A dictionary mapping filenames to dicts with line number keys, - # or mapping filenames to dicts with line number pairs as keys. + # A dictionary mapping filenames to dicts with line number keys (if not + # branch coverage), or mapping filenames to dicts with line number + # pairs as keys (if branch coverage). self.data = {} + # A dictionary mapping filenames to plugin names that will handle them. self.plugin_data = {} # The .should_trace_cache attribute is a cache from filenames to @@ -322,4 +324,10 @@ class Collector(object): return {} def get_plugin_data(self): + """Return the mapping of source files to plugins. + + Returns: + dict: { filename: plugin_name, ... } + + """ return self.plugin_data |