document types better

This commit is contained in:
Andrew Martin 2016-06-23 15:06:27 -04:00
parent 3240edd8ec
commit 8f70dbe1d1

View File

@ -31,7 +31,7 @@ newtype Indexed a = Indexed { getIndexed :: Int }
deriving (Eq,Ord,Functor,Show,Read)
data HeadingError content = HeadingError
{ headingErrorMissing :: Vector content -- ^ headers that were missing
{ headingErrorMissing :: Vector content -- ^ headers that were missing
, headingErrorDuplicate :: Vector (content,Int) -- ^ headers that occurred more than once
} deriving (Show,Read)
@ -49,11 +49,11 @@ instance Contravariant Headless where
-- Check out @Control.Applicative.Free@ in the @free@ library to
-- learn more about this.
data Decoding f content a where
DecodingPure :: !a
DecodingPure :: !a -- ^ function
-> Decoding f content a
DecodingAp :: !(f content)
-> !(content -> Either String a)
-> !(Decoding f content (a -> b))
DecodingAp :: !(f content) -- ^ header
-> !(content -> Either String a) -- ^ decoding function
-> !(Decoding f content (a -> b)) -- ^ next decoding
-> Decoding f content b
instance Functor (Decoding f content) where