From d93a7d004fe49a14536ac6e2aebc36818514ce46 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Thu, 31 Mar 2022 14:20:10 +0200
Subject: [PATCH] DOC: Formatting and documentation fixup.
---
src/caosdb/configuration.py | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/src/caosdb/configuration.py b/src/caosdb/configuration.py
index 314a1a1d..75827df0 100644
--- a/src/caosdb/configuration.py
+++ b/src/caosdb/configuration.py
@@ -90,15 +90,22 @@ def validate_yaml_schema(valobj):
optional_jsonschema_validate(instance=valobj, schema=schema["schema-pycaosdb-ini"])
else:
warnings.warn("""
- Warning: The validation could not be performed because `jsonschema` is not installed.
- """)
+ Warning: The validation could not be performed because `jsonschema` is not installed.
+ """)
def _read_config_files():
- """Function to read config files from different paths. Checks for path in $PYCAOSDBINI or home directory (.pycaosdb.ini) and in the current working directory (pycaosdb.ini).
+ """Function to read config files from different paths.
+
+ Checks for path either in ``$PYCAOSDBINI`` or home directory (``.pycaosdb.ini``), and
+ additionally in the current working directory (``pycaosdb.ini``).
+
+ Returns
+ -------
+
+ ini files: list
+ The successfully parsed ini-files. Order: env_var or home directory, cwd. Used for testing the function.
- Returns:
- [list]: list with successfully parsed ini-files. Order: env_var or home directory, cwd. Used for testing the function.
"""
return_var = []
if "PYCAOSDBINI" in environ:
--
GitLab