[commit: ghc] master: Comments in rejigConRes (d9b0be3)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/d9b0be3cb888a6342af7e4737dd034b68fe77543/ghc

>---------------------------------------------------------------

commit d9b0be3cb888a6342af7e4737dd034b68fe77543
Author: Simon Peyton Jones <simonpj at microsoft.com>
Date:   Thu Apr 9 15:02:34 2015 +0100

    Comments in rejigConRes


>---------------------------------------------------------------

d9b0be3cb888a6342af7e4737dd034b68fe77543
 compiler/typecheck/TcTyClsDecls.hs | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/compiler/typecheck/TcTyClsDecls.hs b/compiler/typecheck/TcTyClsDecls.hs
index 9c9481f..2f9d336 100644
--- a/compiler/typecheck/TcTyClsDecls.hs
+++ b/compiler/typecheck/TcTyClsDecls.hs
@@ -1323,11 +1323,13 @@ rejigConRes tmpl_tvs res_ty dc_tvs ResTyH98
   = (tmpl_tvs, dc_tvs, [], res_ty)
         -- In H98 syntax the dc_tvs are the existential ones
         --      data T a b c = forall d e. MkT ...
-        -- The {a,b,c} are tc_tvs, and {d,e} are dc_tvs
+        -- The universals {a,b,c} are tc_tvs, and the existentials {d,e} are dc_tvs
 
 rejigConRes tmpl_tvs res_tmpl dc_tvs (ResTyGADT _ res_ty)
         -- E.g.  data T [a] b c where
         --         MkT :: forall x y z. T [(x,y)] z z
+        -- The {a,b,c} are the tmpl_tvs, and the {x,y,z} are the dc_tvs
+        --     (NB: unlike the H98 case, the dc_tvs are not all existential)
         -- Then we generate
         --      Univ tyvars     Eq-spec
         --          a              a~(x,y)
@@ -1340,7 +1342,10 @@ rejigConRes tmpl_tvs res_tmpl dc_tvs (ResTyGADT _ res_ty)
     Just subst = tcMatchTy (mkVarSet tmpl_tvs) res_tmpl res_ty
                 -- This 'Just' pattern is sure to match, because if not
                 -- checkValidDataCon will complain first.
-               -- See Note [Checking GADT return types]
+                -- But care: this only works if the result of rejigConRes
+                --           is not demanded until checkValidDataCon has
+                --           first succeeded
+                -- See Note [Checking GADT return types]
 
                 -- /Lazily/ figure out the univ_tvs etc
                 -- Each univ_tv is either a dc_tv or a tmpl_tv