Add (basic) API docs for ServerT (#1573)

This commit is contained in:
Daan Rijks 2023-01-09 17:05:08 +01:00 committed by GitHub
parent a22600979a
commit 2daae80ea8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 0 deletions

2
changelog.d/1573 Normal file
View File

@ -0,0 +1,2 @@
synopsis: Add API docs for ServerT
prs: #1573

View File

@ -116,6 +116,10 @@ import Servant.API.TypeLevel
(AtLeastOneFragment, FragmentUnique)
class HasServer api context where
-- | The type of a server for this API, given a monad to run effects in.
--
-- Note that the result kind is @*@, so it is /not/ a monad transformer, unlike
-- what the @T@ in the name might suggest.
type ServerT api (m :: * -> *) :: *
route ::