comments

diff --git a/Types/Messages.hs b/Types/Messages.hs
index 273fd713b2c9bd56256298ae2a51300df46ae609..b61eec8cc9fbe31a20a40107b7ceea4da7004411 100644 (file)
--- a/Types/Messages.hs
+++ b/Types/Messages.hs
@@ -61,9 +61,14 @@ newMessageState = do
                , promptLock = promptlock
                }
 
+-- | When communicating with a child process over a pipe while it is
+-- performing some action, this is used to pass back output that the child
+-- would normally display to the console.
 data SerializedOutput
        = OutputMessage S.ByteString
        | OutputError String
        | ProgressMeter (Maybe Integer) MeterState MeterState
        | JSONObject L.ByteString
+       -- ^ This is always sent, it's up to the consumer to decide if it
+       -- wants to display JSON, or human-readable messages.
        deriving (Show, Read)