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 | 13765fe075fd9c7075b130f76317972da87f2b9b (patch) | |
| tree | 762eb6db78ad0f01ca82fcafdb6d7538ca83ae94 /doc/api.rst | |
| parent | b5ad7d3f30ad817a0e126cdad1be3ae0df6910c6 (diff) | |
| download | python-coveragepy-git-13765fe075fd9c7075b130f76317972da87f2b9b.tar.gz | |
Clarify when coverage measurement actually starts. #102
Diffstat (limited to 'doc/api.rst')
| -rw-r--r-- | doc/api.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api.rst b/doc/api.rst index 09b94af4..9ce1ee1e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -8,6 +8,7 @@ Coverage API :history: 20090613T164000, final touches for 3.0 :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. The API to coverage.py is very simple, contained in a single module called @@ -20,11 +21,13 @@ in the command line interface. For example, a simple use would be:: cov = coverage.coverage() cov.start() - # .. run your code .. + # .. call your code .. cov.stop() cov.save() + cov.html_report() + The coverage module ------------------- |