diff --git a/src/linkahead/configuration.py b/src/linkahead/configuration.py index 75e36d9ba1e0dd016174ad1eecb74cd41d649101..c65d63d4f155f4f86831e41a0e2105d16e2e7809 100644 --- a/src/linkahead/configuration.py +++ b/src/linkahead/configuration.py @@ -96,16 +96,18 @@ def validate_yaml_schema(valobj): def _read_config_files(): - """Function to read config files from different paths. + """Read config files from different paths. - Checks for path either in ``$PYLINKAHEADINI`` or home directory (``.pylinkahead.ini``), and - additionally in the current working directory (``pylinkahead.ini``). + Read the config from either ``$PYLINKAHEADINI`` or home directory (``~/.pylinkahead.ini``), and + additionally adds config from a config file in the current working directory + (``pylinkahead.ini``). All of these are optional. Returns ------- ini files: list - The successfully parsed ini-files. Order: env_var or home directory, cwd. Used for testing the function. + The successfully parsed ini-files. Order: environment variable or home directory, then cwd. + Used for testing the function. """ return_var = []