From 578c5ca77b37a077cd6c5e3e94855c7444003e39 Mon Sep 17 00:00:00 2001 From: "Matthias C. M. Troffaes" Date: Wed, 24 Jun 2015 10:17:29 +0100 Subject: Improve documentation of getResourceBody, getResourceString, and getResourceLBS. See issue #228. --- src/Hakyll/Core/Compiler.hs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src') 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 -- cgit v1.2.3