diff options
| -rw-r--r-- | CHANGES.txt | 12 | ||||
| -rw-r--r-- | coverage/control.py | 5 |
2 files changed, 10 insertions, 7 deletions
diff --git a/CHANGES.txt b/CHANGES.txt index 1300faf6..7ff2da98 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -17,18 +17,18 @@ Version 3.5.4b1 switch that indicates in the exit status whether the coverage percentage was less than a particular value. Closes `issue 139`_. +- The reporting functions coverage.report(), coverage.html_report(), and + coverage.xml_report() now all return a float, the total percentage covered + measurement. + - The HTML report's title can now be set in the configuration file, with the ``--title`` switch on the command line, or via the API. - Embarrassingly, the `[xml] output=' setting in the .coveragerc file simply didn't work. Now it does. -- The reporting functions coverage.report(), coverage.html_report(), and - coverage.xml_report() now all return a float, the total percentage covered - measurement. - -- On Windows, files are now reported in their correct case. Fixes - `issue 89`_ and `issue 203`_. +- On Windows, files are now reported in their correct case, fixing `issue 89`_ + and `issue 203`_. - Running an HTML report in Python 3 in the same directory as an old Python 2 HTML report would fail with a UnicodeDecodeError. This issue (`issue 193`_) diff --git a/coverage/control.py b/coverage/control.py index 6f15bf9d..0588e68e 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -17,7 +17,7 @@ from coverage.summary import SummaryReporter from coverage.xmlreport import XmlReporter class coverage(object): - """Programmatic access to Coverage. + """Programmatic access to coverage.py. To use:: @@ -325,6 +325,9 @@ class coverage(object): Coverage measurement actually occurs in functions called after `start` is invoked. Statements in the same scope as `start` won't be measured. + Once you invoke `start`, you must also call `stop` eventually, or your + process might not shut down cleanly. + """ if self.run_suffix: # Calling start() means we're running code, so use the run_suffix |