summaryrefslogtreecommitdiff
path: root/coverage/collector.py
diff options
context:
space:
mode:
Diffstat (limited to 'coverage/collector.py')
-rw-r--r--coverage/collector.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/coverage/collector.py b/coverage/collector.py
index 6a2caf86..1a831c19 100644
--- a/coverage/collector.py
+++ b/coverage/collector.py
@@ -127,7 +127,9 @@ class Collector(object):
tracing functions make the faster more sophisticated trace function not
operate properly.
- TODO: `branch`
+ If `branch` is true, then branches will be measured. This involves
+ collecting data on which statements followed each other (arcs). Use
+ `get_arc_data` to get the arc data.
"""
self.should_trace = should_trace
@@ -245,7 +247,10 @@ class Collector(object):
"""Return the arc data collected.
Data is { filename: { (l1, l2): None, ...}, ...}
-
+
+ Note that no data is collected or returned if the Collector wasn't
+ created with `branch` true.
+
"""
if self.branch:
return self.data