on master help sign in
Document HTable
commitf88c51953c5c7c6fb200344d1c59080ec3eddffe authorOllie Charles <ollie@ocharles.org.uk> dateWed 24 Mar 2021, 13:33 (6 years ago) parent04e24ae
1 file changed+6
src/Rel8/Schema/HTable.hs+6
src/Rel8/Schema/HTable.hs+6
@@ -44,6 +44,12 @@ import qualified Rel8.Schema.Kind as K
4444import Data.Functor.Apply ( Apply, (<.>) )
4545
4646
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.
4753type HTable :: K.HTable -> Constraint
4854class HTable t where
4955 type HField t = (field :: Spec -> Type) | field -> t