Merge branch 'master' of github.com:mokus0/dependent-sum

Conflicts:
	src/Data/Dependent/Sum.hs
	src/Data/GADT/Compare.hs

src/Data/Dependent/Sum.hs

@@ -55,6 +55,8 @@ infixr 1 :=>
 -- >     showTaggedPrec AnInt   = showsPrec
 -- 
 class GShow tag => ShowTag tag where
+    -- |Given a value of type @tag a@, return the 'showsPrec' function for 
+    -- the type parameter @a@.
     showTaggedPrec :: tag a -> Int ->     a -> ShowS
 
 instance ShowTag tag => Show (DSum tag) where
@@ -82,6 +84,8 @@ instance ShowTag tag => Show (DSum tag) where
 -- Note that 'eqTagged' is not called until after the tags have been
 -- compared, so it only needs to consider the cases where 'gcompare' returns 'GEQ'.
 class GEq tag => EqTag tag where
+    -- |Given two values of type @tag a@ (for which 'gcompare' returns 'GEQ'),
+    -- return the '==' function for the type @a@.
     eqTagged :: tag a -> tag a -> a -> a -> Bool
 
 instance EqTag tag => Eq (DSum tag) where
@@ -103,7 +107,12 @@ instance EqTag tag => Eq (DSum tag) where
 -- > instance OrdTag Tag where
 -- >     compareTagged AString AString = compare
 -- >     compareTagged AnInt   AnInt   = compare
+-- 
+-- As with 'eqTagged', 'compareTagged' only needs to consider cases where
+-- 'gcompare' returns 'GEQ'.
 class (EqTag tag, GCompare tag) => OrdTag tag where
+    -- |Given two values of type @tag a@ (for which 'gcompare' returns 'GEQ'),
+    -- return the 'compare' function for the type @a@.
     compareTagged :: tag a -> tag a -> a -> a -> Ordering
 
 instance OrdTag tag => Ord (DSum tag) where

src/Data/GADT/Compare.hs

@@ -112,6 +112,8 @@ instance Show (GOrdering a b) where
 
 -- |Type class for orderable GADT-like structures.  When 2 things are equal,
 -- must return a witness that their parameter types are equal as well (GEQ).
+-- |Type class for comparable GADT-like structures.  When 2 things are equal,
+-- must return a witness that their parameter types are equal as well ('GEQ').
 class GEq f => GCompare f where
     gcompare :: f a -> f b -> GOrdering a b
 

src/Data/GADT/Show.hs

@@ -5,6 +5,8 @@ module Data.GADT.Show where
 -- type or should be expected to know how to do so already.  For now, one will
 -- be provided.
 class GShow t where
+    -- |Given the 'showsPrec' function of the type parameter @a@, return a
+    -- 'showsPrec' function for the type @t a@.
     gshowsPrec :: (Int -> a -> ShowS) -> Int -> t a -> ShowS