summaryrefslogtreecommitdiff
path: root/doc/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api.rst')
-rw-r--r--doc/api.rst15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/api.rst b/doc/api.rst
index 98187a8f..03cc7607 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -6,11 +6,12 @@ Coverage API
:history: 20090524T134300, brand new docs.
:history: 20090613T164000, final touches for 3.0
+:history: 20100221T151500, docs for 3.3 (on the plane back from PyCon)
The API to coverage.py is very simple, contained in a single module called
-coverage containing a single class, also called coverage. Methods on the
-coverage object correspond to operations available in the command line
-interface. For example, a simple use would be::
+`coverage`. Most of the interface is in a single class, also called
+`coverage`. Methods on the coverage object correspond to operations available
+in the command line interface. For example, a simple use would be::
import coverage
@@ -30,3 +31,11 @@ The coverage module
.. autoclass:: coverage
:members:
+
+
+Starting coverage automatically
+-------------------------------
+
+This is cool.
+
+.. autofunction:: process_startup