on dev help sign in
argument docstrings
commit1b0f63a6f2b35a9ef1e8b16759ce657115ce90ba authorEitan Chatav <eitan.chatav@gmail.com> dateSun 3 Jun 2018, 11:07 (8 years ago) parent2c7844e
1 file changed+7
squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+7
squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+7
@@ -806,7 +806,9 @@ dropView v = UnsafeDefinition $ "DROP VIEW" <+> renderAlias v <> ";"
806806createTypeEnum
807807 :: (KnownSymbol enum, SOP.All KnownSymbol labels)
808808 => Alias enum
809+ -- ^ name of the user defined enumerated type
809810 -> NP PGlabel labels
811+ -- ^ labels of the enumerated type
810812 -> Definition schema (Create enum ('Typedef ('PGenum labels)) schema)
811813createTypeEnum enum labels = UnsafeDefinition $
812814 "CREATE" <+> "TYPE" <+> renderAlias enum <+> "AS" <+>
@@ -826,6 +828,7 @@ createTypeEnumWith
826828 , KnownSymbol enum
827829 )
828830 => Alias enum
831+ -- ^ name of the user defined enumerated type
829832 -> Definition schema (Create enum ('Typedef (EnumWith hask)) schema)
830833createTypeEnumWith enum = createTypeEnum enum
831834 (SOP.hpure label :: NP PGlabel (LabelsWith hask))
@@ -838,7 +841,9 @@ createTypeEnumWith enum = createTypeEnum enum
838841createTypeComposite
839842 :: (KnownSymbol ty, SOP.SListI fields)
840843 => Alias ty
844+ -- ^ name of the user defined composite type
841845 -> NP (Aliased TypeExpression) fields
846+ -- ^ list of attribute names and data types
842847 -> Definition schema (Create ty ('Typedef ('PGcomposite fields)) schema)
843848createTypeComposite ty fields = UnsafeDefinition $
844849 "CREATE" <+> "TYPE" <+> renderAlias ty <+> "AS" <+> parenthesized
@@ -858,6 +863,7 @@ createTypeCompositeWith
858863 , KnownSymbol ty
859864 )
860865 => Alias ty
866+ -- ^ name of the user defined composite type
861867 -> Definition schema (Create ty ( 'Typedef (CompositeWith hask)) schema)
862868createTypeCompositeWith ty = createTypeComposite ty $ zipAs
863869 (SOP.hpure Alias :: NP Alias (FieldNamesWith hask))
@@ -874,6 +880,7 @@ createTypeCompositeWith ty = createTypeComposite ty $ zipAs
874880dropType
875881 :: Has tydef schema ('Typedef ty)
876882 => Alias tydef
883+ -- ^ name of the user defined type
877884 -> Definition schema (Drop tydef schema)
878885dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderAlias tydef <> ";"
879886