From 2daae80ea8790147b2589e047ca8b209f20b51b4 Mon Sep 17 00:00:00 2001 From: Daan Rijks Date: Mon, 9 Jan 2023 17:05:08 +0100 Subject: [PATCH] Add (basic) API docs for ServerT (#1573) --- changelog.d/1573 | 2 ++ servant-server/src/Servant/Server/Internal.hs | 4 ++++ 2 files changed, 6 insertions(+) create mode 100644 changelog.d/1573 diff --git a/changelog.d/1573 b/changelog.d/1573 new file mode 100644 index 00000000..dc5e79fe --- /dev/null +++ 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 index 8623f1f9..d1bde0bf 100644 --- 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 ::