summaryrefslogtreecommitdiff
path: root/coverage/control.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-02-22 07:22:52 -0500
committerNed Batchelder <ned@nedbatchelder.com>2010-02-22 07:22:52 -0500
commitd16df59ff31dda7ae5b062786798d72460c33357 (patch)
tree63ab9314de9bf0d5048d649c82dd3b1f199b7477 /coverage/control.py
parent4421797d3dddd1a9616c8164cc611aa998d385c3 (diff)
downloadpython-coveragepy-d16df59ff31dda7ae5b062786798d72460c33357.tar.gz
Fiddling with docs for 3.3
Diffstat (limited to 'coverage/control.py')
-rw-r--r--coverage/control.py19
1 files changed, 13 insertions, 6 deletions
diff --git a/coverage/control.py b/coverage/control.py
index f705732..a42d083 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -393,7 +393,7 @@ class coverage(object):
file_to_close.close()
def sysinfo(self):
- """Return a list of key,value pairs showing internal information."""
+ """Return a list of (key, value) pairs showing internal information."""
import coverage as covmod
import platform, re
@@ -420,15 +420,22 @@ class coverage(object):
def process_startup():
"""Call this at Python startup to perhaps measure coverage.
- To invoke this when Python starts, you can create a .pth file in your
- Python installation containing this::
-
- import coverage; coverage.process_startup()
-
If the environment variable COVERAGE_PROCESS_START is defined, coverage
measurement is started. The value of the variable is the config file
to use.
+ There are two ways to configure your Python installation to invoke this
+ function when Python starts:
+
+ #. Create or append to sitecustomize.py to add these lines::
+
+ import coverage
+ coverage.process_startup()
+
+ #. Create a .pth file in your Python installation containing::
+
+ import coverage; coverage.process_startup()
+
"""
cps = os.environ.get("COVERAGE_PROCESS_START")
if cps: