[commit: ghc] wip/ttypeable: Clarify comments (6371dba)

[git at git.haskell.org]

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

On branch  : wip/ttypeable
Link       : http://ghc.haskell.org/trac/ghc/changeset/6371dbaeb0eb6e9eed81fac498853d3e41a43cdc/ghc

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

commit 6371dbaeb0eb6e9eed81fac498853d3e41a43cdc
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Sun Jul 17 22:02:55 2016 +0200

    Clarify comments


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

6371dbaeb0eb6e9eed81fac498853d3e41a43cdc
 compiler/prelude/TysPrim.hs      | 7 ++++---
 compiler/typecheck/TcTypeable.hs | 4 ++--
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/compiler/prelude/TysPrim.hs b/compiler/prelude/TysPrim.hs
index 83ee6a3..80e2049 100644
--- a/compiler/prelude/TysPrim.hs
+++ b/compiler/prelude/TysPrim.hs
@@ -160,10 +160,11 @@ primTyCons
     ]
 
 -- | The names of the 'TyCon's which we define 'Typeable' bindings for
--- explicitly in "Data.Typeable.Internal"
--- and should not generate bindings for in "GHC.Types".
+-- explicitly in "Data.Typeable.Internal" and should not generate representation
+-- bindings for in "GHC.Types".
 --
--- See Note [Mutually recursive representations of primitive types]
+-- See Note [Mutually recursive representations of primitive types] in
+-- "Data.Typeable.Internal" and Note [Grand plan for Typeable] in "TcTypeable".
 primTypeableTyCons :: NameEnv TyConRepName
 primTypeableTyCons = mkNameEnv
     [ (tYPETyConName, trTYPEName)
diff --git a/compiler/typecheck/TcTypeable.hs b/compiler/typecheck/TcTypeable.hs
index d27b509..402f64c 100644
--- a/compiler/typecheck/TcTypeable.hs
+++ b/compiler/typecheck/TcTypeable.hs
@@ -168,9 +168,9 @@ mkTypeableTyConBinds tycons
        ; gbl_env <- tcExtendGlobalValEnv tycon_rep_ids getGblEnv
        ; return (gbl_env `addTypecheckedBinds` tc_binds) }
 
--- | Generate bindings for the type representation of a wired-in TyCon defined
+-- | Generate bindings for the type representation of a wired-in 'TyCon's defined
 -- by the virtual "GHC.Prim" module. This is where we inject the representation
--- bindings for primitive types into "GHC.Types"
+-- bindings for these primitive types into "GHC.Types"
 --
 -- See Note [Grand plan for Typeable] in this module.
 mkPrimTypeableBinds :: TcM TcGblEnv