diff options
| author | Matthias C. M. Troffaes <matthias.troffaes@gmail.com> | 2015-06-24 10:17:29 +0100 |
|---|---|---|
| committer | Matthias C. M. Troffaes <matthias.troffaes@gmail.com> | 2015-06-24 10:17:29 +0100 |
| commit | 578c5ca77b37a077cd6c5e3e94855c7444003e39 (patch) | |
| tree | 07223d16e82fdbfc1d606c1f78fa418a76a71178 /src | |
| parent | 58f4bd8d72cd54912e0b25bf40fd100c9e0b9447 (diff) | |
| download | hakyll-578c5ca77b37a077cd6c5e3e94855c7444003e39.tar.gz | |
Improve documentation of getResourceBody, getResourceString, and getResourceLBS.
See issue #228.
Diffstat (limited to 'src')
| -rw-r--r-- | src/Hakyll/Core/Compiler.hs | 7 |
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 |