Add haddock for runHeadlessApp

reflex-frp · Apr 30, 2020 · 3a6b598 · 3a6b598
1 parent b432a09
commit 3a6b598
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/Reflex/Host/Headless.hs b/src/Reflex/Host/Headless.hs
@@ -38,6 +38,9 @@ type MonadHeadlessApp t m =
   , Adjustable t m
   )
 
+-- | Run a headless FRP network. Inside the action, you will most probably use
+-- the capabilities provided by the 'TriggerEvent' and 'PerformEvent' type class
+-- to interface the FRP network with the outside world. Useful for testing.
 runHeadlessApp
   :: (forall t m. MonadHeadlessApp t m => m (Event t ()))
   -> IO ()