@@ -47,6 +47,7 @@ import Rel8.Table
50+-- | The kind of 'Rel8able' types
50type KRel8able :: Type
51type KRel8able :: Type
51type KRel8able = K.Rel8able
52type KRel8able = K.Rel8able
@@ -62,34 +63,34 @@ type KRel8able = K.Rel8able
62-- , fieldN :: Column f Tn OR HKn f
63-- , fieldN :: Column f Tn OR HKn f
66-- where @Tn@ is any Haskell type, and @HKn@ is any higher-kinded type.
67-- where @Tn@ is any Haskell type, and @HKn@ is any higher-kinded type.
68-- That is, higher-kinded data are records where all fields in the record are
69-- That is, higher-kinded data are records where all fields in the record are
69-- all either of the type @Column f T@ (for any @T@), or are themselves
70-- all either of the type @Column f T@ (for any @T@), or are themselves
70-- higher-kinded data:
71-- higher-kinded data:
72-- [Nested]
73-- [Nested]
75-- data Nested f =
76-- data Nested f =
76-- Nested { nested1 :: MyType f
77-- Nested { nested1 :: MyType f
77-- , nested2 :: MyType f
78-- , nested2 :: MyType f
81-- The @Rel8able@ type class is used to give us a special mapping operation
82-- The @Rel8able@ type class is used to give us a special mapping operation
82-- that lets us change the type parameter @f@.
83-- that lets us change the type parameter @f@.
84-- [Supplying @Rel8able@ instances]
85-- [Supplying @Rel8able@ instances]
86-- This type class should be derived generically for all table types in your
87-- This type class should be derived generically for all table types in your
87-- project. To do this, enable the @DeriveAnyType@ and @DeriveGeneric@ language
88-- project. To do this, enable the @DeriveAnyType@ and @DeriveGeneric@ language
88-- extensions:
89-- extensions:
91-- \{\-\# LANGUAGE DeriveAnyClass, DeriveGeneric #-\}
92-- \{\-\# LANGUAGE DeriveAnyClass, DeriveGeneric #-\}
93-- data MyType f = MyType { fieldA :: Column f T }
94-- data MyType f = MyType { fieldA :: Column f T }
94-- deriving ( GHC.Generics.Generic, Rel8able )
95-- deriving ( GHC.Generics.Generic, Rel8able )