summaryrefslogtreecommitdiff
path: root/coverage/control.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-11-12 09:45:19 -0500
committerNed Batchelder <ned@nedbatchelder.com>2012-11-12 09:45:19 -0500
commit2be7a0db8713bbcc8682eb58c7d1b5b5a9b2c06f (patch)
tree0975514b7ff3c3e598272f3b848801f166f52085 /coverage/control.py
parent531fe69e4d514110e66a7435096b202bc437faa6 (diff)
downloadpython-coveragepy-git-2be7a0db8713bbcc8682eb58c7d1b5b5a9b2c06f.tar.gz
Edits
Diffstat (limited to 'coverage/control.py')
-rw-r--r--coverage/control.py5
1 files changed, 4 insertions, 1 deletions
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