Make NameSort note into proper Note
authorMatthew Pickering <matthew.pickering@tweag.io>
Fri, 15 Jun 2018 17:45:17 +0000 (13:45 -0400)
committerBen Gamari <ben@smart-cactus.org>
Fri, 15 Jun 2018 17:45:18 +0000 (13:45 -0400)
Reviewers: adamgundry, bgamari

Reviewed By: bgamari

Subscribers: rwbarton, thomie, carter

Differential Revision: https://phabricator.haskell.org/D4826

compiler/basicTypes/Name.hs

index 564e0e3..d9eacd9 100644 (file)
@@ -115,6 +115,7 @@ data Name = Name {
 -- (and real!) space leaks, due to the fact that we don't look at
 -- the SrcLoc in a Name all that often.
 
+-- See Note [About the NameSorts]
 data NameSort
   = External Module
 
@@ -151,7 +152,7 @@ instance NFData NameSort where
 data BuiltInSyntax = BuiltInSyntax | UserSyntax
 
 {-
-Notes about the NameSorts:
+Note [About the NameSorts]
 
 1.  Initially, top-level Ids (including locally-defined ones) get External names,
     and all other local Ids get Internal names