diff options
| author | Paul Oliver <contact@pauloliver.dev> | 2025-01-27 14:51:28 +0000 |
|---|---|---|
| committer | Paul Oliver <contact@pauloliver.dev> | 2025-01-29 04:12:57 +0000 |
| commit | 9d2f95bb58f856aaf9142426e90e5783c98af8f1 (patch) | |
| tree | 9453d5cbed1ae2165e6c8f0824ded00d2372e7bd /hsm-core/Hsm/Core/Fsm.hs | |
| parent | 9310ba7e17f97c4570dce33552b3605155ca5c0c (diff) | |
Makes doc-comments cleaner/more elegant
Diffstat (limited to 'hsm-core/Hsm/Core/Fsm.hs')
| -rw-r--r-- | hsm-core/Hsm/Core/Fsm.hs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/hsm-core/Hsm/Core/Fsm.hs b/hsm-core/Hsm/Core/Fsm.hs index d1c2f5d..b04cca3 100644 --- a/hsm-core/Hsm/Core/Fsm.hs +++ b/hsm-core/Hsm/Core/Fsm.hs @@ -26,8 +26,9 @@ data FsmOutput i o env sta = data FsmResult i o env sta = FsmResult o sta (FsmState i o env sta) --- Finite state machines allow processing of stream elements using pure --- functions. One or more FSMs can be included within a `Streamly` pipeline. +-- Finite State Machine (FSM): Implements a finite state machine for +-- processing individual stream elements using pure functions. Multiple FSMs +-- can be included as elements in a `Streamly` pipeline. fsm :: forall i o env sta es. ( Log :> es |