diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-04-26 11:44:11 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-04-26 11:44:11 +0200 |
| commit | a5d33f95ba68263e6c0ca758c5b854530332d9ae (patch) | |
| tree | 798d1ac821262e00e4e44592e788637cd8fa41ab /docs/src/gettingstarted/debugging/README.md | |
| parent | ef70ea3c783be09501053469c5b4b5bb51ef2df2 (diff) | |
Docs: Add more info about debugging (logging and FSM)
Diffstat (limited to 'docs/src/gettingstarted/debugging/README.md')
| -rw-r--r-- | docs/src/gettingstarted/debugging/README.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/gettingstarted/debugging/README.md b/docs/src/gettingstarted/debugging/README.md new file mode 100644 index 0000000..e3a1ecd --- /dev/null +++ b/docs/src/gettingstarted/debugging/README.md @@ -0,0 +1,6 @@ +# Debugging + +To debug this library, e.g. to discover bugs or to see how it works internally, the library comes with a few nice additions. + +## The debug variable +To enable debugging, set debugging to True in the method that registers the code with the library (see [API](../api/index.html)). This sets the logging level to `INFO` (meaning show all messages), and generates a Finite State Machine (FSM) PNG file. We explain in more detail what these two components (logging and FSM) exactly are and how they can be used. |