Improve doc of DFST

1 files changed, 6 insertions, 1 deletions

diff --git a/edit-lens/src/Data/String/DFST.hs b/edit-lens/src/Data/String/DFST.hs
index 702a0d8..2eeb368 100644
--- a/edit-lens/src/Data/String/DFST.hs
+++ b/edit-lens/src/Data/String/DFST.hs
@@ -28,7 +28,12 @@ runDFST :: forall state. Ord state => DFST state -> String -> Maybe String
 runDFST dfst@DFST{..} str = let (finalState, str') = runDFST' dfst stInitial str id
                             in str' "" <$ guard (finalState `Set.member` stAccept)
 
-runDFST' :: forall state. Ord state => DFST state -> state -> String -> (String -> String) -> (state, (String -> String))
+runDFST' :: forall state. Ord state
+         => DFST state
+         -> state -- ^ Current state
+         -> String -- ^ Remaining input
+         -> (String -> String) -- ^ Output as difference list
+         -> (state, (String -> String)) -- ^ Next state, altered output
 runDFST' _ st [] acc = (st, acc)
 runDFST' dfst@DFST{..} st (c:cs) acc
   | Just (st', mc') <- stTransition !? (st, c)