diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-12 00:01:59 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-12 00:01:59 -0500 |
commit | d8622edb21c4c44b9e5cba6ad07d70da8383faf6 (patch) | |
tree | 56ec685292611854ab1d6737ffa5290d8f63ab67 /coverage/control.py | |
parent | 32afd146a0d3e1d8a1e8e443324cec3926306bdf (diff) | |
download | python-coveragepy-d8622edb21c4c44b9e5cba6ad07d70da8383faf6.tar.gz |
Clarify when coverage measurement actually starts. #102
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/coverage/control.py b/coverage/control.py index 20afff5..6f15bf9 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -25,7 +25,7 @@ class coverage(object): cov = coverage() cov.start() - #.. blah blah (run your code) blah blah .. + #.. call your code .. cov.stop() cov.html_report(directory='covhtml') @@ -320,7 +320,12 @@ class coverage(object): self.data.read() def start(self): - """Start measuring code coverage.""" + """Start measuring code coverage. + + Coverage measurement actually occurs in functions called after `start` + is invoked. Statements in the same scope as `start` won't be measured. + + """ if self.run_suffix: # Calling start() means we're running code, so use the run_suffix # as the data_suffix when we eventually save the data. |