Update isAuthorized documentation

2011-12-04 22:49:36 +01:00 · 2011-12-04 22:49:36 +01:00 · 2e1aa2d261
commit 2e1aa2d261
parent d54c336933
1 changed files with 3 additions and 3 deletions
--- a/yesod-core/Yesod/Internal/Core.hs
+++ b/yesod-core/Yesod/Internal/Core.hs
@ -170,9 +170,9 @@ class RenderRoute (Route a) => Yesod a where

    -- | Determine if a request is authorized or not.
    --
-    -- Return 'Nothing' is the request is authorized, 'Just' a message if
-    -- unauthorized. If authentication is required, you should use a redirect;
-    -- the Auth helper provides this functionality automatically.
+    -- Return 'Authorized' if the request is authorized,
+    -- 'Unauthorized' a message if unauthorized.
+    -- If authentication is required, return 'AuthenticationRequired'.
    isAuthorized :: Route a
                 -> Bool -- ^ is this a write request?
                 -> GHandler s a AuthResult