Skip to content

Commit ad0e92e

Browse files
authored
docs: Improving docs for async. Closes #502 (#505)
1 parent 2977f83 commit ad0e92e

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/async.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,23 @@ Engines are internal and are activated automatically by inspecting the registere
4747
4848
```
4949

50+
Outer scope
51+
: The context in which the state machine **instance** is created.
52+
53+
Async callbacks?
54+
: Indicates whether the state machine has declared asynchronous callbacks or conditions.
55+
56+
Engine
57+
: The engine that will be utilized.
58+
59+
Creates internal loop
60+
: Specifies whether the state machine initiates a new event loop if no [asyncio loop is running](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_running_loop).
61+
62+
Reuses external loop
63+
: Indicates whether the state machine reuses an existing [asyncio loop](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_running_loop) if one is already running.
64+
65+
66+
5067
```{note}
5168
All handlers will run on the same thread they are called. Therefore, mixing synchronous and asynchronous code is not recommended unless you are confident in your implementation.
5269
```

0 commit comments

Comments
 (0)