diff options
| -rw-r--r-- | coverage/data.py | 11 | ||||
| -rw-r--r-- | doc/api.rst | 11 |
2 files changed, 16 insertions, 6 deletions
diff --git a/coverage/data.py b/coverage/data.py index 945875c8..197dbd34 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 7c6dda35..268c6133 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 ------------------------------- |