diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2014-08-19 13:29:24 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2014-08-19 13:29:24 -0400 |
| commit | 0e3d0775462159fd46493e25bcb07936766e7ae5 (patch) | |
| tree | dc8b0ae018c2085ea721d933ae11d213e887b011 | |
| parent | 2a84eaf05129d335064ffbb75346b5b106a5cfb0 (diff) | |
| download | python-coveragepy-git-0e3d0775462159fd46493e25bcb07936766e7ae5.tar.gz | |
Also update the docs for the Coverage name.
| -rw-r--r-- | CHANGES.txt | 3 | ||||
| -rw-r--r-- | doc/api.rst | 9 |
2 files changed, 8 insertions, 4 deletions
diff --git a/CHANGES.txt b/CHANGES.txt index 539037a5..2f71f63d 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -18,6 +18,9 @@ Change history for Coverage.py - The XML report now contains a <source> element, fixing `issue 94`_. Thanks Stan Hu. +- The class defined in the coverage module is now called ``Coverage`` instead + of ``coverage``, though the old name still works, for backward compatibility. + - The ``fail-under`` value is now rounded the same as reported results, preventing paradoxical results, fixing `issue 284`_. diff --git a/doc/api.rst b/doc/api.rst index a43de17f..0a00947e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -9,16 +9,17 @@ Coverage API :history: 20100221T151500, docs for 3.3 (on the plane back from PyCon) :history: 20100725T211700, updated for 3.4. :history: 20121111T235800, added a bit of clarification. +:history: 20140819T132600, change class name to Coverage The API to coverage.py is very simple, contained in a single module called -`coverage`. Most of the interface is in a single class, also called -`coverage`. Methods on the coverage object correspond roughly to operations +`coverage`. Most of the interface is in a single class, called +`Coverage`. Methods on the Coverage object correspond roughly to operations available in the command line interface. For example, a simple use would be:: import coverage - cov = coverage.coverage() + cov = coverage.Coverage() cov.start() # .. call your code .. @@ -34,7 +35,7 @@ The coverage module .. module:: coverage -.. autoclass:: coverage +.. autoclass:: Coverage :members: |