cleaned: fileSourceByteString: document comment

from code review.
2018-04-17 18:01:36 +09:00 · 2018-04-17 18:01:36 +09:00 · 1e89f4d4c3
commit 1e89f4d4c3
parent 11159f3a75
1 changed files with 3 additions and 2 deletions
--- a/yesod-core/Yesod/Core/Handler.hs
+++ b/yesod-core/Yesod/Core/Handler.hs
@ -1362,8 +1362,9 @@ rawRequestBody = do
 fileSource :: MonadResource m => FileInfo -> ConduitT () S.ByteString m ()
 fileSource = transPipe liftResourceT . fileSourceRaw

-- | Strict `ByteString` body from `FileInfo`.
-- This function blocking while read file.
+-- | Extract a strict `ByteString` body from a `FileInfo`.
+--
+-- This function will block while reading the file.
 --
 -- > do
 -- >     fileByteString <- fileSourceByteString fileInfo