From 9576700a77eb97c409ef9628b4a04fc275945dd6 Mon Sep 17 00:00:00 2001 From: Jasper Van der Jeugt Date: Sat, 27 Feb 2010 17:35:39 +0100 Subject: Some more documentation. --- src/Text/Hakyll/Hakyll.hs | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'src') diff --git a/src/Text/Hakyll/Hakyll.hs b/src/Text/Hakyll/Hakyll.hs index 4f36c88..7554972 100644 --- a/src/Text/Hakyll/Hakyll.hs +++ b/src/Text/Hakyll/Hakyll.hs @@ -29,5 +29,13 @@ data HakyllConfiguration = HakyllConfiguration type Hakyll = ReaderT HakyllConfiguration IO -- | Simplified @ask@ function for the Hakyll monad stack. +-- +-- Usage would typically be something like: +-- +-- > doSomething :: a -> b -> Hakyll c +-- > doSomething arg1 arg2 = do +-- > siteDirectory' <- askHakyll siteDirectory +-- > ... +-- askHakyll :: (HakyllConfiguration -> a) -> Hakyll a askHakyll = flip liftM ask -- cgit v1.2.3