summaryrefslogtreecommitdiff
path: root/coverage/control.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2009-12-23 21:57:09 -0500
committerNed Batchelder <ned@nedbatchelder.com>2009-12-23 21:57:09 -0500
commitd7bbe09016e4ea584e5bfd9bf8e62f08b4ab5efc (patch)
tree1c32f692ba2da12cb0b1d612377612688be3dce2 /coverage/control.py
parente7abaf77929c5f74e3535988a5953c7133263385 (diff)
downloadpython-coveragepy-d7bbe09016e4ea584e5bfd9bf8e62f08b4ab5efc.tar.gz
process_startup is a better name for the new function.
Diffstat (limited to 'coverage/control.py')
-rw-r--r--coverage/control.py11
1 files changed, 8 insertions, 3 deletions
diff --git a/coverage/control.py b/coverage/control.py
index 4acef71..415df27 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -373,11 +373,16 @@ class coverage(object):
return info
-def measure_process():
- """Called at Python startup time to perhaps measure coverage.
+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, and the value of the variable is the data file
+ measurement is started. The value of the variable is the data file
prefix to use.
"""