summaryrefslogtreecommitdiff
path: root/coverage/data.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-08-02 19:05:04 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-08-02 19:05:04 -0400
commitafa75d3bd2097d8817afa20f67202b396d0cbc92 (patch)
tree7cd09f94c7097526b3ef2c76dd87360c6d696442 /coverage/data.py
parent2dc976f0e69450c08fca02c3d7bbb909d04ab04a (diff)
downloadpython-coveragepy-git-afa75d3bd2097d8817afa20f67202b396d0cbc92.tar.gz
Tweak the plugin docs
Diffstat (limited to 'coverage/data.py')
-rw-r--r--coverage/data.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/coverage/data.py b/coverage/data.py
index 56233e5e..3491c3d8 100644
--- a/coverage/data.py
+++ b/coverage/data.py
@@ -48,6 +48,10 @@ class CoverageData(object):
written during "coverage run", and then accumulated during "coverage
combine".
+ Lines, arcs, and file tracer names are stored for each source file. File
+ names in this API are case-sensitive, even on platforms with
+ case-insensitive file systems.
+
To read a coverage.py data file, use :meth:`.read_file`, or :meth:`.read`
if you have an already-opened file. You can then access the line, arc, or
file tracer data with :meth:`.lines`, :meth:`.arcs`, or
@@ -78,8 +82,6 @@ class CoverageData(object):
"""
- # TODO: case-sensitivity in file names in these methods.
-
# The data file format is JSON, with these keys:
#
# * lines: a dict mapping filenames to lists of line numbers