From 6f0c575c9f538ed2d4ee88453d2f20bc9848866c Mon Sep 17 00:00:00 2001 From: "David R. MacIver" Date: Fri, 15 Sep 2017 11:40:25 +0100 Subject: Fixes documentation comments about arguments to Collector. --- coverage/collector.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'coverage/collector.py') 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" -- cgit v1.2.1