Skip to content
Snippets Groups Projects
Verified Commit cbefcbb1 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

DOC: Updated documentation a bit.

parent 23ade264
No related branches found
No related tags found
1 merge request!111MAINT: LinkAhead rename
......@@ -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 = []
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment