summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2015-06-24 22:09:03 +0200
committerJasper Van der Jeugt <jaspervdj@gmail.com>2015-06-24 22:09:03 +0200
commit43c4e2a82e080ea63dd25dff7df270e30d0e65d6 (patch)
tree07223d16e82fdbfc1d606c1f78fa418a76a71178 /src
parent58f4bd8d72cd54912e0b25bf40fd100c9e0b9447 (diff)
parent578c5ca77b37a077cd6c5e3e94855c7444003e39 (diff)
downloadhakyll-43c4e2a82e080ea63dd25dff7df270e30d0e65d6.tar.gz
Merge pull request #354 from mcmtroffaes/patch-1
Improve documentation of getResourceXXX functions.
Diffstat (limited to 'src')
-rw-r--r--src/Hakyll/Core/Compiler.hs7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/Hakyll/Core/Compiler.hs b/src/Hakyll/Core/Compiler.hs
index 2fc60ce..f99f93b 100644
--- a/src/Hakyll/Core/Compiler.hs
+++ b/src/Hakyll/Core/Compiler.hs
@@ -83,19 +83,20 @@ getRoute identifier = do
--------------------------------------------------------------------------------
--- | Get the body of the underlying resource
+-- | Get the full contents of the matched source file as a string,
+-- but without metadata preamble, if there was one.
getResourceBody :: Compiler (Item String)
getResourceBody = getResourceWith resourceBody
--------------------------------------------------------------------------------
--- | Get the resource we are compiling as a string
+-- | Get the full contents of the matched source file as a string.
getResourceString :: Compiler (Item String)
getResourceString = getResourceWith resourceString
--------------------------------------------------------------------------------
--- | Get the resource we are compiling as a lazy bytestring
+-- | Get the full contents of the matched source file as a lazy bytestring.
getResourceLBS :: Compiler (Item ByteString)
getResourceLBS = getResourceWith resourceLBS