diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2009-05-26 23:41:24 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-05-26 23:41:24 -0400 |
| commit | a70319af59dc99373fa1b8febd0bbf86b6ca5200 (patch) | |
| tree | e1c4f9cf247b7318c5fc4123d5ab714b430d609c /doc/api.rst | |
| parent | c77c6649d8438762f20fd9e15cf6c4cc9b94643b (diff) | |
| download | python-coveragepy-a70319af59dc99373fa1b8febd0bbf86b6ca5200.tar.gz | |
First successful coversion .rst -> .px -> .html
Diffstat (limited to 'doc/api.rst')
| -rw-r--r-- | doc/api.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/api.rst b/doc/api.rst index 285ca3d..279e9db 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -4,6 +4,30 @@ Coverage API ============ +The API to coverage.py is very simple, contained in a single module called +coverage containing a single class, also called coverage:: + + import coverage + + cov = coverage.coverage() + +Methods on the coverage object correspond to operations available in the +command line interface. For example, a simple use would be:: + + import coverage + + cov = coverage.coverage() + cov.start() + + # .. run your code .. + + cov.stop() + cov.save() + + +The coverage module +------------------- + .. module:: coverage .. autoclass:: coverage |
