From 6d79cab810cac3e7350c9dcbafbf51453b63efba Mon Sep 17 00:00:00 2001
From: Ned Batchelder <ned@nedbatchelder.com>
Date: Wed, 10 Jun 2009 08:45:05 -0400
Subject: Add a comment about the proper way to import the coverage() class,
 and remove a now-unused attribute.

---
 coverage/control.py | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'coverage/control.py')

diff --git a/coverage/control.py b/coverage/control.py
index b564819b..993cf973 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -12,7 +12,17 @@ from coverage.summary import SummaryReporter
 
 class coverage:
     """Programmatic access to Coverage.
+
+    To use::
     
+        from coverage import coverage
+        
+        cov = coverage()
+        cov.start()
+        #.. blah blah (run your code) blah blah
+        cov.stop()
+        cov.html_report(directory='covhtml')
+
     """
     def __init__(self, data_file=None, data_suffix=False, cover_pylib=False,
                 auto_data=False):
@@ -42,7 +52,6 @@ class coverage:
         self.exclude_list = []
         
         self.file_locator = FileLocator()
-        self.sysprefix = self.file_locator.abs_file(sys.prefix)
         
         self.collector = Collector(self._should_trace)
 
-- 
cgit v1.2.1