From ca6e49360be1b7d25b0ff4c11473063ffc05f1e7 Mon Sep 17 00:00:00 2001
From: Ned Batchelder <ned@nedbatchelder.com>
Date: Tue, 26 May 2009 23:41:24 -0400
Subject: First successful coversion .rst -> .px -> .html

---
 doc/api.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'doc/api.rst')

diff --git a/doc/api.rst b/doc/api.rst
index 285ca3d1..279e9dbb 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
-- 
cgit v1.2.1