diff options
| author | Lucas Hoffmann <l-m-h@web.de> | 2017-06-06 23:01:26 +0200 |
|---|---|---|
| committer | Lucas Hoffmann <l-m-h@web.de> | 2017-06-06 23:01:26 +0200 |
| commit | f0a4c83f4d27d013106f4018fbbf629fb4ac7e69 (patch) | |
| tree | d67b17ccd8b64c621d14d00c1ce15af6ffba9931 /alot/settings/utils.py | |
| parent | fbc223984e3555b4c50b0ad7b9eb9f24d6ae1ac9 (diff) | |
Extend docs for settings.utils.read_config
The argument is handed to ConfigObj directly and allowing lines of text
to be passed here makes future tests much easier.
Diffstat (limited to 'alot/settings/utils.py')
| -rw-r--r-- | alot/settings/utils.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/alot/settings/utils.py b/alot/settings/utils.py index 3cdb51ad..23278607 100644 --- a/alot/settings/utils.py +++ b/alot/settings/utils.py @@ -13,8 +13,8 @@ def read_config(configpath=None, specpath=None, checks=None): """ get a (validated) config object for given config file path. - :param configpath: path to config-file - :type configpath: str + :param configpath: path to config-file or a list of lines as its content + :type configpath: str or list(str) :param specpath: path to spec-file :type specpath: str :param checks: custom checks to use for validator. |