diff options
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. |