diff options
| author | Ned Batchelder <nedbat@gmail.com> | 2017-09-23 20:32:13 +0000 |
|---|---|---|
| committer | Ned Batchelder <nedbat@gmail.com> | 2017-09-23 20:32:13 +0000 |
| commit | a839976986a6344e474ca3432e9bb5839b51c1ed (patch) | |
| tree | 166114e7219d53e8c9830e2872b1cbb274342bf7 | |
| parent | fb6f438ac4a0181a71df7af53e7d99e86851c78b (diff) | |
| parent | 6f0c575c9f538ed2d4ee88453d2f20bc9848866c (diff) | |
| download | python-coveragepy-git-a839976986a6344e474ca3432e9bb5839b51c1ed.tar.gz | |
Merged in david_maciver_/coverage.py (pull request #129)
Fixes documentation comments about arguments to Collector.
| -rw-r--r-- | coverage/collector.py | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/coverage/collector.py b/coverage/collector.py index cfdcf402..90c32756 100644 --- a/coverage/collector.py +++ b/coverage/collector.py @@ -71,8 +71,8 @@ class Collector(object): def __init__(self, should_trace, check_include, timid, branch, warn, concurrency): """Create a collector. - `should_trace` is a function, taking a file name, and returning a - `coverage.FileDisposition object`. + `should_trace` is a function, taking a file name and a frame, and + returning a `coverage.FileDisposition object`. `check_include` is a function taking a file name and a frame. It returns a boolean: True if the file should be traced, False if not. @@ -86,8 +86,9 @@ class Collector(object): collecting data on which statements followed each other (arcs). Use `get_arc_data` to get the arc data. - `warn` is a warning function, taking a single string message argument, - to be used if a warning needs to be issued. + `warn` is a warning function, taking a single string message argument + and an optional slug argument which will be a string or None, to be + used if a warning needs to be issued. `concurrency` is a list of strings indicating the concurrency libraries in use. Valid values are "greenlet", "eventlet", "gevent", or "thread" |