document what this argument is

This commit is contained in:
Ben Sima 2020-10-20 17:27:13 -04:00
parent 6732cffcbc
commit 7beb29d1bb

View File

@ -110,7 +110,13 @@ ack sess ship eventId =
]
-- |
subscribe :: Ship -> Path -> OutputStream ByteString -> IO ()
subscribe ::
Ship ->
Path ->
-- | A handler function to receiv the response from the server, e.g.
-- 'System.IO.Streams.stdout`.
OutputStream ByteString ->
IO ()
subscribe ship path outfn = Client.get addr handle
where
handle :: Response -> InputStream ByteString -> IO ()