janishutz/BiogasControllerApp
1
0
Fork 0
mirror of https://github.com/janishutz/BiogasControllerApp.git synced 2025-11-25 05:44:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs for config

Browse Source
This commit is contained in:
Janis Hutz
2025-11-19 12:24:08 +01:00
parent d1ba8d4d0e
commit f8fb015de3
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
util/config.py
View File

@@ -47,11 +47,12 @@ def read_config(
key_0: The first key (top level)
key_1: The second key (where the actual key-value pair is)
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
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
tmp = {}