summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-07-11 19:31:29 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-07-11 19:31:29 -0400
commit7e766b953c2422cccb212f346687dea39d676746 (patch)
tree38fcc57e5340788a6f63b5b2fa846a5a0af46327
parenta2742dd17a0536eddba983e6716a4931ce0d9fe0 (diff)
downloadpython-coveragepy-7e766b953c2422cccb212f346687dea39d676746.tar.gz
Include CoverageData in the docs
-rw-r--r--coverage/data.py11
-rw-r--r--doc/api.rst11
2 files changed, 16 insertions, 6 deletions
diff --git a/coverage/data.py b/coverage/data.py
index 945875c..197dbd3 100644
--- a/coverage/data.py
+++ b/coverage/data.py
@@ -16,13 +16,16 @@ class CoverageData(object):
* collector: a string identifying the collecting software
* lines: a dict mapping filenames to sorted lists of line numbers
- executed:
- { 'file1': [17,23,45], 'file2': [1,2,3], ... }
+ executed::
+
+ { 'file1': [17,23,45], 'file2': [1,2,3], ... }
+
+ * arcs: a dict mapping filenames to sorted lists of line number pairs::
- * arcs: a dict mapping filenames to sorted lists of line number pairs:
{ 'file1': [(17,23), (17,25), (25,26)], ... }
- * plugins: a dict mapping filenames to plugin names:
+ * plugins: a dict mapping filenames to plugin names::
+
{ 'file1': "django.coverage", ... }
"""
diff --git a/doc/api.rst b/doc/api.rst
index 7c6dda3..268c613 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -30,8 +30,8 @@ available in the command line interface. For example, a simple use would be::
cov.html_report()
-The coverage module
--------------------
+The Coverage class
+------------------
.. module:: coverage
@@ -40,6 +40,13 @@ The coverage module
:exclude-members: use_cache
+The CoverageData class
+----------------------
+
+.. autoclass:: CoverageData
+ :members:
+
+
Starting coverage automatically
-------------------------------