Added some docs

2013-03-21 08:30:09 +02:00 · 2013-03-21 08:30:09 +02:00 · ff3eb746f1
commit ff3eb746f1
parent 0546d566c3
1 changed files with 6 additions and 0 deletions
--- a/yesod-core/Yesod/Core/Handler.hs
+++ b/yesod-core/Yesod/Core/Handler.hs
@ -909,6 +909,12 @@ fileSource = transPipe liftResourceT . fileSourceRaw

 -- | Use a @Source@ for the response body.
 --
+-- Note that, for ease of use, the underlying monad is a @HandlerT@. This
+-- implies that you can run any @HandlerT@ action. However, since a streaming
+-- response occurs after the response headers have already been sent, some
+-- actions make no sense here. For example: short-circuit responses, setting
+-- headers, changing status codes, etc.
+--
 -- Since 1.2.0
 respondSource :: ContentType
              -> Source (HandlerT site IO) (Flush Builder)