More documentation

snapframework · Sep 3, 2012 · 103bf47 · 103bf47
1 parent aece75e
commit 103bf47
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/Snap/Snaplet/Heist.hs b/src/Snap/Snaplet/Heist.hs
@@ -177,8 +177,8 @@ renderAs ct t = withTop' heistLens (Unclassed.renderAs ct t)
 
 
 ------------------------------------------------------------------------------
--- | Renders a template as text\/html. If the given template is not found,
--- this returns 'empty'.
+-- | Renders a compiled template as text\/html. If the given template is not
+-- found, this returns 'empty'.
 cRender :: HasHeist b
         => ByteString
         -- ^ Template name
@@ -187,8 +187,8 @@ cRender t = withTop' heistLens (Unclassed.cRender t)
 
 
 ------------------------------------------------------------------------------
--- | Renders a template as the given content type.  If the given template
--- is not found, this returns 'empty'.
+-- | Renders a compiled template as the given content type.  If the given
+-- template is not found, this returns 'empty'.
 cRenderAs :: HasHeist b
           => ByteString
           -- ^ Content type to render with

diff --git a/src/Snap/Snaplet/HeistNoClass.hs b/src/Snap/Snaplet/HeistNoClass.hs
@@ -373,6 +373,10 @@ withHeistState heist f = withHeistState' (subSnaplet heist) f
 
 
 ------------------------------------------------------------------------------
+-- | Adds more HeistConfig data using mappend with whatever is currently
+-- there.  This is the preferred method for adding all four kinds of splices
+-- as well as new
+-- templates.
 addConfig :: Snaplet (Heist b)
           -> HeistConfig (Handler b b)
           -> Initializer b v ()