summaryrefslogtreecommitdiff
path: root/coverage/collector.py
diff options
context:
space:
mode:
authorDavid R. MacIver <david@drmaciver.com>2017-09-15 11:40:25 +0100
committerDavid R. MacIver <david@drmaciver.com>2017-09-15 11:40:25 +0100
commit6f0c575c9f538ed2d4ee88453d2f20bc9848866c (patch)
tree69db98626d735805ac7c756142406cee5ec365a3 /coverage/collector.py
parent519ab678a99831d22aa23db6c9ef7981d61563ef (diff)
downloadpython-coveragepy-git-6f0c575c9f538ed2d4ee88453d2f20bc9848866c.tar.gz
Fixes documentation comments about arguments to Collector.
Diffstat (limited to 'coverage/collector.py')
-rw-r--r--coverage/collector.py9
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"