Skip to content

Commit 3c83f61

Browse files
committed
Write explicit export list in Servant.API.TypeLevel
1 parent 6cf3188 commit 3c83f61

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

servant/src/Servant/API/TypeLevel.hs

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,32 @@ The code samples in this module use the following type synonym:
1818
> :<|> "bye" :> Capture "name" String :> Post '[JSON, PlainText] Bool
1919
2020
-}
21-
module Servant.API.TypeLevel where
21+
module Servant.API.TypeLevel (
22+
-- $setup
23+
-- * API predicates
24+
Endpoints,
25+
-- ** Lax inclusion
26+
IsElem',
27+
IsElem,
28+
IsSubAPI,
29+
AllIsElem,
30+
-- ** Strict inclusion
31+
IsIn,
32+
IsStrictSubAPI,
33+
AllIsIn,
34+
-- * Helpers
35+
-- ** Lists
36+
MapSub,
37+
AppendList,
38+
IsSubList,
39+
Elem,
40+
ElemGo,
41+
Or,
42+
And,
43+
-- * Custom type errors
44+
-- | Before @base-4.9.0.0@ we use non-exported 'ElemNotFoundIn' class,
45+
-- which cannot be instantiated.
46+
) where
2247

2348

2449
import GHC.Exts (Constraint)
@@ -223,6 +248,9 @@ families are not evaluated (see https://ghc.haskell.org/trac/ghc/ticket/12048).
223248

224249

225250
-- $setup
251+
--
252+
-- The doctests in this module are run with following preamble:
253+
--
226254
-- >>> :set -XPolyKinds
227255
-- >>> :set -XGADTs
228256
-- >>> import Data.Proxy

0 commit comments

Comments
 (0)