diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-10 08:45:05 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-10 08:45:05 -0400 |
commit | 6d79cab810cac3e7350c9dcbafbf51453b63efba (patch) | |
tree | 0280f1e80eb4cf628f6442a2d2d62311fa09b82d | |
parent | fedbbd4169378f6b807c13806b4415878a788bca (diff) | |
download | python-coveragepy-git-6d79cab810cac3e7350c9dcbafbf51453b63efba.tar.gz |
Add a comment about the proper way to import the coverage() class, and remove a now-unused attribute.
-rw-r--r-- | coverage/control.py | 11 |
1 files changed, 10 insertions, 1 deletions
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) |