@@ -532,7 +532,7 @@ from tables = TableExpression tables [] NoGroups NoHaving [] [] []
532-- | A `where_` is an endomorphism of `TableExpression`s which adds a
532-- | A `where_` is an endomorphism of `TableExpression`s which adds a
533-- search condition to the `whereClause`.
533-- search condition to the `whereClause`.
535− :: Condition tables 'Ungrouped params
535+ :: Condition tables 'Ungrouped params -- ^ filtering condition
536 -> TableExpression schema params tables grouping
536 -> TableExpression schema params tables grouping
537 -> TableExpression schema params tables grouping
537 -> TableExpression schema params tables grouping
538where_ wh tables = tables {whereClause = wh : whereClause tables}
538where_ wh tables = tables {whereClause = wh : whereClause tables}
@@ -542,7 +542,7 @@ where_ wh tables = tables {whereClause = wh : whereClause tables}
542-- a "grand total" aggregation query.
542-- a "grand total" aggregation query.
544 :: SListI bys
544 :: SListI bys
545− => NP (By tables) bys
545+ => NP (By tables) bys -- ^ grouped columns
546 -> TableExpression schema params tables 'Ungrouped
546 -> TableExpression schema params tables 'Ungrouped
547 -> TableExpression schema params tables ('Grouped bys)
547 -> TableExpression schema params tables ('Grouped bys)
548group bys tables = TableExpression
548group bys tables = TableExpression
@@ -558,7 +558,7 @@ group bys tables = TableExpression
558-- | A `having` is an endomorphism of `TableExpression`s which adds a
558-- | A `having` is an endomorphism of `TableExpression`s which adds a
559-- search condition to the `havingClause`.
559-- search condition to the `havingClause`.
561− :: Condition tables ('Grouped bys) params
561+ :: Condition tables ('Grouped bys) params -- ^ having condition
562 -> TableExpression schema params tables ('Grouped bys)
562 -> TableExpression schema params tables ('Grouped bys)
563 -> TableExpression schema params tables ('Grouped bys)
563 -> TableExpression schema params tables ('Grouped bys)
564having hv tables = tables
564having hv tables = tables
@@ -567,7 +567,7 @@ having hv tables = tables
567-- | An `orderBy` is an endomorphism of `TableExpression`s which appends an
567-- | An `orderBy` is an endomorphism of `TableExpression`s which appends an
568-- ordering to the right of the `orderByClause`.
568-- ordering to the right of the `orderByClause`.
570− :: [SortExpression tables grouping params]
570+ :: [SortExpression tables grouping params] -- ^ sort expressions
571 -> TableExpression schema params tables grouping
571 -> TableExpression schema params tables grouping
572 -> TableExpression schema params tables grouping
572 -> TableExpression schema params tables grouping
573orderBy srts tables = tables {orderByClause = orderByClause tables ++ srts}
573orderBy srts tables = tables {orderByClause = orderByClause tables ++ srts}
@@ -575,7 +575,7 @@ orderBy srts tables = tables {orderByClause = orderByClause tables ++ srts}
575-- | A `limit` is an endomorphism of `TableExpression`s which adds to the
575-- | A `limit` is an endomorphism of `TableExpression`s which adds to the
576-- `limitClause`.
576-- `limitClause`.
578− :: Word64
578+ :: Word64 -- ^ limit parameter
579 -> TableExpression schema params tables grouping
579 -> TableExpression schema params tables grouping
580 -> TableExpression schema params tables grouping
580 -> TableExpression schema params tables grouping
581limit lim tables = tables {limitClause = lim : limitClause tables}
581limit lim tables = tables {limitClause = lim : limitClause tables}
@@ -583,7 +583,7 @@ limit lim tables = tables {limitClause = lim : limitClause tables}
583-- | An `offset` is an endomorphism of `TableExpression`s which adds to the
583-- | An `offset` is an endomorphism of `TableExpression`s which adds to the
584-- `offsetClause`.
584-- `offsetClause`.
586− :: Word64
586+ :: Word64 -- ^ offset parameter
587 -> TableExpression schema params tables grouping
587 -> TableExpression schema params tables grouping
588 -> TableExpression schema params tables grouping
588 -> TableExpression schema params tables grouping
589offset off tables = tables {offsetClause = off : offsetClause tables}
589offset off tables = tables {offsetClause = off : offsetClause tables}