Some documentation updates

Next target for cleanup: Yesod.Form, Yesod.Formable and
Yesod.Helpers.Crud.
This commit is contained in:
Michael Snoyman 2010-06-30 21:55:23 +03:00
parent ea48760294
commit 95047029f8
3 changed files with 7 additions and 3 deletions

View File

@ -35,8 +35,8 @@ import Yesod.Content
#endif
-- | A monad for generating Json output. In truth, it is just a newtype wrapper
-- around 'Hamlet'; we thereby get the benefits of Hamlet (interleaving IO and
-- enumerator output) without accidently mixing non-JSON content.
-- around 'Html'; we thereby get the benefits of BlazeHtml (type safety and
-- speed) without accidently mixing non-JSON content.
--
-- This is an opaque type to avoid any possible insertion of non-JSON content.
-- Due to the limited nature of the JSON format, you can create any valid JSON

View File

@ -63,12 +63,14 @@ instance RequestReader ((->) Request) where
-- | Get the list of supported languages supplied by the user.
--
-- Languages are determined based on the following three (in descending order
-- of preference:
-- of preference):
--
-- * The _LANG get parameter.
--
-- * The _LANG cookie.
--
-- * The _LANG user session variable.
--
-- * Accept-Language HTTP header.
--
-- This is handled by the parseWaiRequest function in Yesod.Dispatch (not

View File

@ -41,6 +41,8 @@ class YesodSite y where
getSite :: Site (Routes y) (Method -> Maybe (Handler y ChooseRep))
type Method = String
-- | Same as 'YesodSite', but for subsites. Once again, users should not need
-- to deal with it directly, as the mkYesodSub creates instances appropriately.
class YesodSubSite s y where
getSubSite :: Site (Routes s) (Method -> Maybe (GHandler s y ChooseRep))