summaryrefslogtreecommitdiff
path: root/coverage/config.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2016-11-20 09:17:57 -0500
committerNed Batchelder <ned@nedbatchelder.com>2016-11-20 09:17:57 -0500
commit87e2fe503a813c2396b1a9ec6865013d0cfccd08 (patch)
tree8fc6b5eb83406e4a3e4b9242c126f5782d5370a1 /coverage/config.py
parentafe3955c48db6c4ef6501e657ba7fc03a1b69d5d (diff)
downloadpython-coveragepy-git-87e2fe503a813c2396b1a9ec6865013d0cfccd08.tar.gz
Fix the docstring
Diffstat (limited to 'coverage/config.py')
-rw-r--r--coverage/config.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/coverage/config.py b/coverage/config.py
index 7adcba39..6750b793 100644
--- a/coverage/config.py
+++ b/coverage/config.py
@@ -385,12 +385,13 @@ class CoverageConfig(object):
def read_coverage_config(config_file, **kwargs):
- """Read configuration, returning a `CoverageConfig` object.
+ """Read the coverage.py configuration.
Arguments:
config_file: a boolean or string, see the `Coverage` class for the
tricky details.
- all others: key
+ all others: keyword arguments from the `Coverage` class, used for
+ setting values in the configuration.
Returns:
config_file, config: