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
commit8aee57ccb388674d49d0f7278c9ced247eb0872d (patch)
tree4daef35f725f4046913fd3e622c157cedb41f32e /coverage/config.py
parent52f7bb335ce25063cd33a91c4f9e757adb18e99c (diff)
downloadpython-coveragepy-8aee57ccb388674d49d0f7278c9ced247eb0872d.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 7adcba3..6750b79 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: