From 3a6b5987c83cbb85aa592187ff4c92de88419be2 Mon Sep 17 00:00:00 2001
From: Carlo Nucera <carlo.nucera@protonmail.com>
Date: Thu, 30 Apr 2020 12:14:39 -0400
Subject: [PATCH] Add haddock for runHeadlessApp

---
 src/Reflex/Host/Headless.hs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/Reflex/Host/Headless.hs b/src/Reflex/Host/Headless.hs
index a19f48af..8dd0c8b8 100644
--- 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 ()