From a5d33f95ba68263e6c0ca758c5b854530332d9ae Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Tue, 26 Apr 2022 11:44:11 +0200 Subject: Docs: Add more info about debugging (logging and FSM) --- docs/src/gettingstarted/debugging/logging.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/src/gettingstarted/debugging/logging.md (limited to 'docs/src/gettingstarted/debugging/logging.md') diff --git a/docs/src/gettingstarted/debugging/logging.md b/docs/src/gettingstarted/debugging/logging.md new file mode 100644 index 0000000..a1cfc97 --- /dev/null +++ b/docs/src/gettingstarted/debugging/logging.md @@ -0,0 +1,8 @@ +# Logging +As said, logging is used. The logging gets saved in a client-specified directory (see [API](../../api/index.html)). Logging has the following levels: + +- `INFO`: Messages purely for info, these do not indicate any errors. They are merely there for debugging purposes +- `WARNING`: This message indicates a warning, this can be e.g. non-fatal errors +- `ERROR`: Fatal errors which refuses the app from working + +By default only messages below or equal to `WARNING` are logged (`WARNING`, `ERROR`). However, if the debug variable is set to `True`, all messages will be logged into the log file. -- cgit v1.2.3