documentation fixes & formatting #3

This commit is contained in:
Mark Wotton 2016-03-21 17:41:25 -04:00
parent b21e64637f
commit 23278d651e

View File

@ -695,16 +695,15 @@ get url = request $ do
setUrl url setUrl url
-- | Follow a redirect, if the last response was a redirect. -- | Follow a redirect, if the last response was a redirect.
-- | (We consider a request a redirect if the status is -- (We consider a request a redirect if the status is
-- | 301, 302, 303, 307 or 308, and the Location header is set.) -- 301, 302, 303, 307 or 308, and the Location header is set.)
-- |
-- | Return Left with an error message if not a redirect
-- | Return Right with the redirected URL if it was.
-- --
-- ==== __Examples__ -- ==== __Examples__
-- --
-- > get HomeR -- > get HomeR
-- > followRedirect -- > followRedirect
followRedirect :: Yesod site
=> YesodExample site (Either T.Text T.Text) -- ^ 'Left' with an error message if not a redirect, 'Right' with the redirected URL if it was
followRedirect :: Yesod site followRedirect :: Yesod site
=> YesodExample site (Either T.Text T.Text) => YesodExample site (Either T.Text T.Text)
followRedirect = do followRedirect = do