Remove extra parameter from haddock section of Fragment instances (#1362

)
haskell-servant · Nov 22, 2020 · ce63802 · ce63802
1 parent aa4f54e
commit ce63802
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/servant-client-core/src/Servant/Client/Core/HasClient.hs b/servant-client-core/src/Servant/Client/Core/HasClient.hs
@@ -761,11 +761,10 @@ instance ( HasClient m api
 -- > myApi :: Proxy MyApi
 -- > myApi = Proxy
 -- >
--- > getBooksBy :: Maybe Text -> ClientM [Book]
--- > getBooksBy = client myApi
+-- > getBooks :: ClientM [Book]
+-- > getBooks = client myApi
 -- > -- then you can just use "getBooksBy" to query that endpoint.
--- > -- 'getBooksBy Nothing' for all books
--- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
+-- > -- 'getBooks' for all books.
 #ifdef HAS_TYPE_ERROR
 instance (AtLeastOneFragment api, FragmentUnique (Fragment a :> api), HasClient m api
 #else

diff --git a/servant-server/src/Servant/Server/Internal.hs b/servant-server/src/Servant/Server/Internal.hs
@@ -890,9 +890,9 @@ type HasServerArrowTypeError a b =
 -- > type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book]
 -- >
 -- > server :: Server MyApi
--- > server = getBooksBy
--- >   where getBooksBy :: Handler [Book]
--- >         getBooksBy = ...return all books...
+-- > server = getBooks
+-- >   where getBooks :: Handler [Book]
+-- >         getBooks = ...return all books...
 #ifdef HAS_TYPE_ERROR
 instance (AtLeastOneFragment api, FragmentUnique (Fragment a1 :> api), HasServer api context)
 #else