on master help sign in
Some more documentation.
commit9576700a77eb97c409ef9628b4a04fc275945dd6 authorJasper Van der Jeugt <jaspervdj@gmail.com> dateSat 27 Feb 2010, 17:35 (17 years ago) parentea1bb41
1 file changed+8
src/Text/Hakyll/Hakyll.hs+8
src/Text/Hakyll/Hakyll.hs+8
@@ -29,5 +29,13 @@ data HakyllConfiguration = HakyllConfiguration
2929type Hakyll = ReaderT HakyllConfiguration IO
3030
3131-- | Simplified @ask@ function for the Hakyll monad stack.
32+--
33+-- Usage would typically be something like:
34+--
35+-- > doSomething :: a -> b -> Hakyll c
36+-- > doSomething arg1 arg2 = do
37+-- > siteDirectory' <- askHakyll siteDirectory
38+-- > ...
39+--
3240askHakyll :: (HakyllConfiguration -> a) -> Hakyll a
3341askHakyll = flip liftM ask