diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2010-02-22 07:22:52 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2010-02-22 07:22:52 -0500 |
commit | 95b613a9202ec075e68ee0600a880dd8cba26d6c (patch) | |
tree | fee3f38e23f8fac2a9b0b041ed714f6a517a0bc9 /coverage/control.py | |
parent | 1e1c98cd4f3d7ee55f855badaa5fbceae7a6d424 (diff) | |
download | python-coveragepy-git-95b613a9202ec075e68ee0600a880dd8cba26d6c.tar.gz |
Fiddling with docs for 3.3
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/coverage/control.py b/coverage/control.py index f7057323..a42d0835 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: |