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

2017-05-16 16:03:25 +00:00 · 2017-05-16 16:03:25 +00:00 · 021bcd9e23
commit 021bcd9e23
parent 0bbc4f98a4
1 changed files with 3 additions and 1 deletions
--- a/servant/src/Servant/API/Empty.hs
+++ b/servant/src/Servant/API/Empty.hs
@ -6,5 +6,7 @@ import           Data.Typeable    (Typeable)
 import           Prelude ()
 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)