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

haskell-servant · Jan 9, 2023 · 2daae80 · 2daae80
1 parent a226009
commit 2daae80
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/changelog.d/1573 b/changelog.d/1573
@@ -0,0 +1,2 @@
+synopsis: Add API docs for ServerT
+prs: #1573
diff --git a/servant-server/src/Servant/Server/Internal.hs b/servant-server/src/Servant/Server/Internal.hs
@@ -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 ::