Skip to content

Commit 8df3a15

Browse files
committed
Clarify a point in the readme.
1 parent b09d726 commit 8df3a15

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,11 @@ If another event is triggered during a state machine transition, the event will
178178
state the machine was transitioning to or from. Any calls to `transition` with the cancelled async event name
179179
will be invalidated.
180180

181-
For example:
181+
During a state change, `asyncState` will transition from `NONE` to `[event]WaitingOnLeave` to `[event]WaitingOnEnter`,
182+
looping back to `NONE`. If the state machine is put on hold, `asyncState` will pause depending on which handler
183+
you returned `ASYNC` from.
184+
185+
Example of asynchronous transitions:
182186

183187
```lua
184188
local machine = require('statemachine')

0 commit comments

Comments
 (0)