Add more docs and links

swarm-game · Jul 5, 2024 · 7f353a4 · 7f353a4
1 parent 1eb14ec
commit 7f353a4
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/swarm-tui/Swarm/TUI/Model/KeyBindings.hs b/src/swarm-tui/Swarm/TUI/Model/KeyBindings.hs
@@ -1,6 +1,7 @@
 {-# LANGUAGE OverloadedStrings #-}
 
--- |
+-- | Load and show Swarm keybindings.
+--
 -- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.TUI.Model.KeyBindings (
   initKeyHandlingState,
@@ -28,6 +29,8 @@ import Swarm.TUI.Controller.EventHandlers
 import Swarm.TUI.Model
 import Swarm.TUI.Model.Event (SwarmEvent, defaultSwarmBindings, swarmEvents)
 
+-- See Note [how Swarm event handlers work]
+
 loadKeybindingConfig ::
   (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) =>
   m [(SwarmEvent, BindingState)]