From 9d2f95bb58f856aaf9142426e90e5783c98af8f1 Mon Sep 17 00:00:00 2001 From: Paul Oliver Date: Mon, 27 Jan 2025 14:51:28 +0000 Subject: Makes doc-comments cleaner/more elegant --- hsm-core/Hsm/Core/Fsm.hs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'hsm-core/Hsm/Core/Fsm.hs') 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 -- cgit v1.2.1