diff options
| author | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2010-02-27 17:35:39 +0100 |
|---|---|---|
| committer | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2010-02-27 17:35:39 +0100 |
| commit | 9576700a77eb97c409ef9628b4a04fc275945dd6 (patch) | |
| tree | 3f23a0395364e6e1681fb7dfa14983992dc0d03b /src/Text | |
| parent | ea1bb417268692a0e005ec331fb938eb445d01d1 (diff) | |
| download | hakyll-9576700a77eb97c409ef9628b4a04fc275945dd6.tar.gz | |
Some more documentation.
Diffstat (limited to 'src/Text')
| -rw-r--r-- | src/Text/Hakyll/Hakyll.hs | 8 |
1 files changed, 8 insertions, 0 deletions
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 |