summaryrefslogtreecommitdiff
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
parent2dc976f0e69450c08fca02c3d7bbb909d04ab04a (diff)
downloadpython-coveragepy-git-afa75d3bd2097d8817afa20f67202b396d0cbc92.tar.gz
Tweak the plugin docs
-rw-r--r--coverage/data.py6
-rw-r--r--doc/cmd.rst2
-rw-r--r--doc/plugins.rst16
3 files changed, 14 insertions, 10 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
diff --git a/doc/cmd.rst b/doc/cmd.rst
index b1440bb3..a438eb33 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -183,7 +183,7 @@ Combining data files
--------------------
If you need to collect coverage data from different machines or processes,
-coverage.py can combine multiple files into one for reporting.
+coverage.py can combine multiple files into one for reporting.
Once you have created a number of these files, you can copy them all to a
single directory, and use the **combine** command to combine them into one
diff --git a/doc/plugins.rst b/doc/plugins.rst
index a7c911a4..b8cb1f1b 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -13,7 +13,7 @@ Plugins
.. versionadded:: 4.0
-Coverage.py's behavior can be extended by writing plugins. A plugin is a
+Coverage.py's behavior can be extended with third-party plugins. A plugin is a
separately installed Python class that you register in your .coveragerc.
Plugins can be used to implement coverage measurement for non-Python files.
@@ -21,24 +21,26 @@ Using plugins
-------------
To use a coverage.py plugin, you install it, and configure it. For this
-example, let's say you want to use one called fred_plugin.
+example, let's say there's a Python package called ``something`` that provides a
+coverage.py plugin called ``something.plugin``.
-#. Install the plugin as you would any other Python package::
+#. Install the plugin's package as you would any other Python package::
- pip install fred_plugin
+ pip install something
#. Configure coverage.py to use the plugin. You do this by editing (or
creating) your .coveragerc file, as described in :ref:`config`. The
- ``plugins`` setting indicates your plugin::
+ ``plugins`` setting indicates your plugin. It's a list of importable module
+ names of plugins::
[run]
plugins =
- fred_plugin
+ something.plugin
#. If the plugin needs its own configuration, you can add those settings in
the .coveragerc file in a section named for the plugin::
- [fred_plugin]
+ [something.plugin]
option1 = True
option2 = abc.foo