git.iko.soy/servant
on master help sign in
Fix haddock code examples in HasClient (#1640)
commitf71953e63d33823c895b0436d8ce6334ff41552c authorJan Hrcek <2716069+jhrcek@users.noreply.github.com> dateSat 28 Jan 2023, 13:02 (4 years ago) parentc382a1f
5 files changed+7−7
compare with master
unifiedsplit
doc/cookbook/open-id-connect/OpenIdConnect.lhs+1−1 doc/cookbook/uverb/UVerb.lhs+1−1 servant-auth/servant-auth/src/Servant/Auth.hs+1−1 servant-client-core/src/Servant/Client/Core/HasClient.hs+3−3 servant-docs/src/Servant/Docs/Internal.hs+1−1
doc/cookbook/open-id-connect/OpenIdConnect.lhs+1−1
@@ -330,7 +330,7 @@ data Customer = Customer {
330330```
331331
332332Here is the code that displays the homepage.
333−It should contain a link to the the `/login` URL.
333+It should contain a link to the `/login` URL.
334334When the user clicks on this link it will be redirected to Google login page
335335with some generated information.
336336
doc/cookbook/uverb/UVerb.lhs+1−1
@@ -199,7 +199,7 @@ parsers in the hope that the ones that should will always error out so
199199you can try until the right one returns a value.)
200200
201201[servant-exceptions](https://github.com/ch1bo/servant-exceptions) is
202−another shot at at the problem. It is inspired by
202+another shot at the problem. It is inspired by
203203servant-checked-exceptions, so it may be worth taking a closer look.
204204The README claims that
205205[cardano-sl](https://github.com/input-output-hk/cardano-sl) also has
servant-auth/servant-auth/src/Servant/Auth.hs+1−1
@@ -27,7 +27,7 @@ instance HasLink sub => HasLink (Auth (tag :: [*]) value :> sub) where
2727
2828-- ** Combinators
2929
30−-- | A JSON Web Token (JWT) in the the Authorization header:
30+-- | A JSON Web Token (JWT) in the Authorization header:
3131--
3232-- @Authorization: Bearer \<token\>@
3333--
servant-client-core/src/Servant/Client/Core/HasClient.hs+3−3
@@ -902,7 +902,7 @@ infixl 2 /:
902902-- rootClient = client api
903903--
904904-- endpointClient :: ClientM Person
905−-- endpointClient = client // subApi // endpoint
905+-- endpointClient = client \/\/ subApi \/\/ endpoint
906906-- @
907907(//) :: a -> (a -> b) -> b
908908x // f = f x
@@ -935,10 +935,10 @@ x // f = f x
935935-- rootClient = client api
936936--
937937-- hello :: String -> ClientM String
938−-- hello name = rootClient // hello /: name
938+-- hello name = rootClient \/\/ hello \/: name
939939--
940940-- endpointClient :: ClientM Person
941−-- endpointClient = client // subApi /: "foobar123" // endpoint
941+-- endpointClient = client \/\/ subApi \/: "foobar123" \/\/ endpoint
942942-- @
943943(/:) :: (a -> b -> c) -> b -> a -> c
944944(/:) = flip
servant-docs/src/Servant/Docs/Internal.hs+1−1
@@ -447,7 +447,7 @@ docsWith opts intros (ExtraInfo endpoints) p =
447447 & apiEndpoints %~ HM.unionWith (flip combineAction) endpoints
448448
449449
450−-- | Generate the docs for a given API that implements 'HasDocs' with with any
450+-- | Generate the docs for a given API that implements 'HasDocs' with any
451451-- number of introduction(s)
452452docsWithIntros :: HasDocs api => [DocIntro] -> Proxy api -> API
453453docsWithIntros intros = docsWith defaultDocOptions intros mempty