From 00ad7b9a1c798e611a0c0b7fcbfa5ee76c2f39c4 Mon Sep 17 00:00:00 2001
From: Paul Oliver <contact@pauloliver.dev>
Date: Tue, 14 Jan 2025 15:58:56 -0800
Subject: Adds minimal documentation

---
 hsm-core/Hsm/Core/Fsm.hs | 2 ++
 1 file changed, 2 insertions(+)

(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 43fa497..6f9910e 100644
--- a/hsm-core/Hsm/Core/Fsm.hs
+++ b/hsm-core/Hsm/Core/Fsm.hs
@@ -26,6 +26,8 @@ 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.
 fsm ::
      forall i o env sta es.
      ( Log :> es
-- 
cgit v1.2.1