- rec_dotdot :: Maybe Int }
- -- Nothing => the normal case
- -- Just n => the group uses ".." notation,
- -- and the first n elts of rec_flds
- -- were the user-written ones
- -- (In the latter case, the remaining elts of
- -- rec_flds are the non-user-written ones)
+ rec_dotdot :: Maybe Int } -- Note [DotDot fields]
+
+-- Note [DotDot fields]
+-- ~~~~~~~~~~~~~~~~~~~~
+-- The rec_dotdot field means this:
+-- Nothing => the normal case
+-- Just n => the group uses ".." notation,
+--
+-- In the latter case:
+--
+-- *before* renamer: rec_flds are exactly the n user-written fields
+--
+-- *after* renamer: rec_flds includes *all* fields, with
+-- the first 'n' being the user-written ones
+-- and the remainder being 'filled in' implicitly