diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-12 09:45:19 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-12 09:45:19 -0500 |
commit | 839c08ae17908315077ceba765009dc3b9e68e2b (patch) | |
tree | 4ab901ebcd6e0f0290173d7d95390086d6f09d24 /coverage/control.py | |
parent | 744ed958f05cf74b4a41eff14e3eed57fb9d5443 (diff) | |
download | python-coveragepy-839c08ae17908315077ceba765009dc3b9e68e2b.tar.gz |
Edits
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/coverage/control.py b/coverage/control.py index 6f15bf9..0588e68 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 |