summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlly Cope <olly@ollycope.com>2022-11-02 16:30:02 +0000
committerOlly Cope <olly@ollycope.com>2022-11-02 16:30:02 +0000
commit50b31f170744a727801f9b684a4b3de20ffc7e0a (patch)
tree5fcd18a6be7835d515e80cc1c87b578f21df4ba8
parent140ee7f6135e2c65f9dc4d56aa3ac269684a1af2 (diff)
downloadyoyo-50b31f170744a727801f9b684a4b3de20ffc7e0a.tar.gz
config: improve docstring
-rw-r--r--yoyo/config.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/yoyo/config.py b/yoyo/config.py
index 9010cac..6d05f22 100644
--- a/yoyo/config.py
+++ b/yoyo/config.py
@@ -84,8 +84,9 @@ def update_argparser_defaults(parser, defaults):
def read_config(src: Optional[str]) -> ConfigParser:
"""
- Read the configuration file at ``path``, or return an empty
- ConfigParse object if ``path`` is ``None``.
+ Read the configuration file at ``src`` and construct a ConfigParser instance.
+
+ If ``src`` is None a new, empty ConfigParse object will be created.
"""
if src is None:
return get_configparser(get_interpolation_defaults())