Improve docs for config

This commit is contained in:
2025-11-19 12:24:08 +01:00
parent d1ba8d4d0e
commit f8fb015de3
2 changed files with 4 additions and 3 deletions

View File

@@ -208,7 +208,7 @@ if __name__ == "__main__":
# Start the application # Start the application
try: try:
if hasattr(sys, '_MEIPASS'): if hasattr(sys, "_MEIPASS"):
resource_add_path(os.path.join(sys._MEIPASS)) resource_add_path(os.path.join(sys._MEIPASS))
BiogasControllerApp().run() BiogasControllerApp().run()
except Exception as e: except Exception as e:

View File

@@ -47,11 +47,12 @@ def read_config(
key_0: The first key (top level) key_0: The first key (top level)
key_1: The second key (where the actual key-value pair is) key_1: The second key (where the actual key-value pair is)
default: The default value to return if the check fails default: The default value to return if the check fails
valid_entries: [Optiona] The entries that are valid ones to check against valid_entries: [Optional] The entries that are valid ones to check against
type_to_validate: [Optional] Data type to validate type_to_validate: [Optional] Data type to validate
Returns: Returns:
[TODO:return] The read config option as a string. You can cast this to the type you specified with type_to_validate safely.
When converting to a boolean though, use the str_to_bool function provided by this library
""" """
# Try loading the keys # Try loading the keys
tmp = {} tmp = {}