Write explicit export list in Servant.API.TypeLevel

This commit is contained in:
Oleg Grenrus 2017-01-16 13:54:00 +02:00
parent 6cf3188907
commit 3c83f615ca

View file

@ -18,7 +18,32 @@ The code samples in this module use the following type synonym:
> :<|> "bye" :> Capture "name" String :> Post '[JSON, PlainText] Bool > :<|> "bye" :> Capture "name" String :> Post '[JSON, PlainText] Bool
-} -}
module Servant.API.TypeLevel where module Servant.API.TypeLevel (
-- $setup
-- * API predicates
Endpoints,
-- ** Lax inclusion
IsElem',
IsElem,
IsSubAPI,
AllIsElem,
-- ** Strict inclusion
IsIn,
IsStrictSubAPI,
AllIsIn,
-- * Helpers
-- ** Lists
MapSub,
AppendList,
IsSubList,
Elem,
ElemGo,
Or,
And,
-- * Custom type errors
-- | Before @base-4.9.0.0@ we use non-exported 'ElemNotFoundIn' class,
-- which cannot be instantiated.
) where
import GHC.Exts (Constraint) import GHC.Exts (Constraint)
@ -223,6 +248,9 @@ families are not evaluated (see https://ghc.haskell.org/trac/ghc/ticket/12048).
-- $setup -- $setup
--
-- The doctests in this module are run with following preamble:
--
-- >>> :set -XPolyKinds -- >>> :set -XPolyKinds
-- >>> :set -XGADTs -- >>> :set -XGADTs
-- >>> import Data.Proxy -- >>> import Data.Proxy