Comments only, on the invariants of GlobalRdrEnv
authorSimon Peyton Jones <simonpj@microsoft.com>
Mon, 1 Feb 2016 14:01:34 +0000 (14:01 +0000)
committerSimon Peyton Jones <simonpj@microsoft.com>
Mon, 8 Feb 2016 15:08:39 +0000 (15:08 +0000)
compiler/basicTypes/RdrName.hs

index 62771e9..62f473e 100644 (file)
@@ -416,6 +416,13 @@ type GlobalRdrEnv = OccEnv [GlobalRdrElt]
 --              happens only when type-checking a [d| ... |] Template
 --              Haskell quotation; see this note in RnNames
 --              Note [Top-level Names in Template Haskell decl quotes]
+--
+-- INVARIANT 3: If the GlobalRdrEnv maps [occ -> gre], then
+--                 greOccName gre = occ
+--
+--              NB: greOccName gre is usually the same as
+--                  nameOccName (gre_name gre), but not always in the
+--                  case of record seectors; see greOccName
 
 -- | An element of the 'GlobalRdrEnv'
 data GlobalRdrElt