Document that EmptyAPI is, morally speaking, the unit of :<|>

This commit is contained in:
David Turner 2017-05-16 16:03:25 +00:00
parent 0bbc4f98a4
commit 021bcd9e23

View file

@ -6,5 +6,7 @@ import Data.Typeable (Typeable)
import Prelude () import Prelude ()
import Prelude.Compat import Prelude.Compat
-- | An empty API: one which serves nothing. -- | An empty API: one which serves nothing. Morally speaking, this should be
-- the unit of ':<|>'. Implementors of interpretations of API types should
-- treat 'EmptyAPI' as close to the unit as possible.
data EmptyAPI = EmptyAPI deriving (Typeable, Eq, Show, Bounded) data EmptyAPI = EmptyAPI deriving (Typeable, Eq, Show, Bounded)