git.iko.soy/hakyll
on master help sign in
Improve documentation of getResourceBody, getResourceString, and getResourceLBS.
578c5caMatthias C. M. Troffaes
src/Hakyll/Core/Compiler.hs+4−3
compare with master
unifiedsplit
@@ -83,19 +83,20 @@ getRoute identifier = do
83
83
84
84
85--------------------------------------------------------------------------------
85--------------------------------------------------------------------------------
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.
87getResourceBody :: Compiler (Item String)
88getResourceBody :: Compiler (Item String)
88getResourceBody = getResourceWith resourceBody
89getResourceBody = getResourceWith resourceBody
89
90
90
91
91--------------------------------------------------------------------------------
92--------------------------------------------------------------------------------
92−-- | Get the resource we are compiling as a string
93+-- | Get the full contents of the matched source file as a string.
93getResourceString :: Compiler (Item String)
94getResourceString :: Compiler (Item String)
94getResourceString = getResourceWith resourceString
95getResourceString = getResourceWith resourceString
95
96
96
97
97--------------------------------------------------------------------------------
98--------------------------------------------------------------------------------
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.
99getResourceLBS :: Compiler (Item ByteString)
100getResourceLBS :: Compiler (Item ByteString)
100getResourceLBS = getResourceWith resourceLBS
101getResourceLBS = getResourceWith resourceLBS
101
102