From 2bd7673f23bf95a97323c632aeaff35df992c927 Mon Sep 17 00:00:00 2001
From: Jan Tuomi <jans.tuomi@gmail.com>
Date: Sat, 19 Feb 2022 17:06:18 +0200
Subject: Add more docs

---
 src/Interpreter.hs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/Interpreter.hs')

diff --git a/src/Interpreter.hs b/src/Interpreter.hs
index cb71c62..7542fd4 100644
--- a/src/Interpreter.hs
+++ b/src/Interpreter.hs
@@ -7,6 +7,8 @@ import qualified Data.Map as M
 import LTypes
 import Utils
 
+-- | Wait for unbuffered input (any key) from stdin. If 'q', return 'ExecExit', otherwise 'ExecContinue'.
+-- If not in debug mode, immediately return 'ExecContinue' without waiting.
 debugWaitForChar Config {configDebugMode = mode} = do
   if mode
     then do
@@ -16,11 +18,13 @@ debugWaitForChar Config {configDebugMode = mode} = do
         _ -> ExecContinue
     else pure ExecContinue
 
+-- | If in debug mode, print the supplied message, automatically prefixed with "[debug]". Otherwise, no op.
 debugPrint Config {configDebugMode = mode} message =
   if mode
     then liftIO $ putStrLn $ fmt "[debug] %%" [message]
     else pure ()
 
+-- |
 interpretSource :: Config -> LState -> ExceptT LException IO LState
 interpretSource config state@LState {lSource = []} = pure state
 interpretSource config state@LState {lSource = (word : rest)} = do
-- 
cgit v1.3