diff options
| author | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2010-01-21 09:19:14 +0100 |
|---|---|---|
| committer | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2010-01-21 09:19:14 +0100 |
| commit | aaa777180948074f2d65a23aedc4f7fc7e3d4761 (patch) | |
| tree | a72e1dfe09331bffca723042e67abb450429af4d /src/Text/Hakyll/Renderables.hs | |
| parent | cf789c7ac677b9c13ae6f26d7dda950584a373c8 (diff) | |
| download | hakyll-aaa777180948074f2d65a23aedc4f7fc7e3d4761.tar.gz | |
Some more documentation.
Diffstat (limited to 'src/Text/Hakyll/Renderables.hs')
| -rw-r--r-- | src/Text/Hakyll/Renderables.hs | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/Text/Hakyll/Renderables.hs b/src/Text/Hakyll/Renderables.hs index 9e62a91..c7183a8 100644 --- a/src/Text/Hakyll/Renderables.hs +++ b/src/Text/Hakyll/Renderables.hs @@ -64,10 +64,14 @@ data CombinedRenderable a b = CombinedRenderable a b -- | Combine two renderables. The url will always be taken from the first -- "Renderable". Also, if a `$key` is present in both renderables, the -- value from the first "Renderable" will be taken as well. +-- +-- Since renderables are always more or less key-value maps, you can see +-- this as a @union@ between two maps. combine :: (Renderable a, Renderable b) => a -> b -> CombinedRenderable a b combine = CombinedRenderable --- | Combine two renderables and set a custom URL. +-- | Combine two renderables and set a custom URL. This behaves like "combine", +-- except that for the @url@ field, the given URL is always chosen. combineWithURL :: (Renderable a, Renderable b) => FilePath -> a @@ -75,7 +79,7 @@ combineWithURL :: (Renderable a, Renderable b) -> CombinedRenderable a b combineWithURL = CombinedRenderableWithURL --- | Render combinations. +-- Render combinations. instance (Renderable a, Renderable b) => Renderable (CombinedRenderable a b) where |