summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-11-24 21:05:11 -0500
committerNed Batchelder <ned@nedbatchelder.com>2015-11-24 21:05:11 -0500
commitbcfa618e0b2409d6ff38f3854fff2b3a818b7867 (patch)
tree7e44b94d5189608b270f53886a6bc3d9255f68ec
parent216c4bdaceb283bd5a0220d7897bdd8baf816100 (diff)
downloadpython-coveragepy-git-bcfa618e0b2409d6ff38f3854fff2b3a818b7867.tar.gz
Clarify the docs a bit.
-rw-r--r--doc/cmd.rst3
-rw-r--r--doc/config.rst3
2 files changed, 4 insertions, 2 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index dab226d7..c40152e3 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -165,7 +165,8 @@ Data file
---------
Coverage.py collects execution data in a file called ".coverage". If need be,
-you can set a new file name with the COVERAGE_FILE environment variable.
+you can set a new file name with the COVERAGE_FILE environment variable. This
+can include a path to another directory.
By default,each run of your program starts with an empty data set. If you need
to run your program multiple times to get complete data (for example, because
diff --git a/doc/config.rst b/doc/config.rst
index 4ac63d4c..688e8992 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -120,7 +120,8 @@ option, or coverage.py will produce very wrong results.
.. versionadded:: 4.0
``data_file`` (string, default ".coverage"): the name of the data file to use
-for storing or reporting coverage.
+for storing or reporting coverage. This value can include a path to another
+directory.
``debug`` (multi-string): a list of debug options. See :ref:`the run
--debug option <cmd_run_debug>` for details.