on develop help sign in
Rewording scope helpers
commit4c4e3dc8cb742a9c8886ecf1577d4dee16132db9 authorBrendan Hay <brendan.g.hay@gmail.com> dateSun 20 Mar 2016, 17:36 (11 years ago) parent58fc7dc
1 file changed+7−7
gogol/src/Network/Google/Auth/Scope.hs+7−7
gogol/src/Network/Google/Auth/Scope.hs+7−7
@@ -35,21 +35,21 @@ import Network.Google.Prelude (GoogleRequest (..),
3535 OAuthScope (..))
3636import Network.HTTP.Types (urlEncode)
3737
38−-- | Type-restrict the supplied credentials etc. to the specific scopes.
38+-- | Annotate credentials with the specified scopes.
3939--
40−-- This simply exists to allow users to choose between using 'getCredentials'
41−-- with a 'Proxy' type, or explicitly specifying the type annotation without
42−-- having separate functions.
40+-- This exists to allow users to choose between using 'getCredentials'
41+-- with a 'Proxy' type constructed via use of '(!)', or explicitly
42+-- specifying the scopes in a type annotation.
4343--
44−-- /See:/ '!'.
44+-- /See:/ '!' and the related scopes available for each service.
4545allow :: proxy s -> k s -> k s
4646allow _ = id
4747
48−-- | Type-restrict the supplied credentials (etc.) to no scopes.
48+-- | Annotate credentials with no scope authorization.
4949forbid :: k '[] -> k '[]
5050forbid = id
5151
52−-- | Append the type-level lists of two 'Proxy' values.
52+-- | Append two sets of scopes.
5353--
5454-- /See:/ 'allow'.
5555(!) :: proxy xs -> proxy ys -> Proxy (xs ++ ys)