on master help sign in
Document HTable
f88c519Ollie Charles
src/Rel8/Schema/HTable.hs+6
@@ -44,6 +44,12 @@ import qualified Rel8.Schema.Kind as K
44import Data.Functor.Apply ( Apply, (<.>) )
44import Data.Functor.Apply ( Apply, (<.>) )
45
45
46
46
47+-- | A @HTable@ is a functor-indexed/higher-kinded data type that is
48+-- representable ('htabulate'/'hfield'), constrainable ('hdicts'), and
49+-- specified ('hspecs').
50+--
51+-- This is an internal concept for Rel8, and you should not need to define
52+-- instances yourself or specify this constraint.
47type HTable :: K.HTable -> Constraint
53type HTable :: K.HTable -> Constraint
48class HTable t where
54class HTable t where
49 type HField t = (field :: Spec -> Type) | field -> t
55 type HField t = (field :: Spec -> Type) | field -> t