on master help sign in
Improve documentation of getResourceBody, getResourceString, and getResourceLBS.

See issue #228.

commit578c5ca77b37a077cd6c5e3e94855c7444003e39 authorMatthias C. M. Troffaes <matthias.troffaes@gmail.com> dateWed 24 Jun 2015, 10:17 (11 years ago) parent58f4bd8
1 file changed+4−3
src/Hakyll/Core/Compiler.hs+4−3
src/Hakyll/Core/Compiler.hs+4−3
@@ -83,19 +83,20 @@ getRoute identifier = do
8383
8484
8585--------------------------------------------------------------------------------
86−-- | Get the body of the underlying resource
86+-- | Get the full contents of the matched source file as a string,
87+-- but without metadata preamble, if there was one.
8788getResourceBody :: Compiler (Item String)
8889getResourceBody = getResourceWith resourceBody
8990
9091
9192--------------------------------------------------------------------------------
92−-- | Get the resource we are compiling as a string
93+-- | Get the full contents of the matched source file as a string.
9394getResourceString :: Compiler (Item String)
9495getResourceString = getResourceWith resourceString
9596
9697
9798--------------------------------------------------------------------------------
98−-- | Get the resource we are compiling as a lazy bytestring
99+-- | Get the full contents of the matched source file as a lazy bytestring.
99100getResourceLBS :: Compiler (Item ByteString)
100101getResourceLBS = getResourceWith resourceLBS
101102