[commit: ghc] master: Make NameSort note into proper Note (b67b971)

[git at git.haskell.org]

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

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

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

commit b67b971740e77ba5e9e2892ac0f668d41c38381f
Author: Matthew Pickering <matthew.pickering at tweag.io>
Date:   Fri Jun 15 13:45:17 2018 -0400

    Make NameSort note into proper Note
    
    Reviewers: adamgundry, bgamari
    
    Reviewed By: bgamari
    
    Subscribers: rwbarton, thomie, carter
    
    Differential Revision: https://phabricator.haskell.org/D4826


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

b67b971740e77ba5e9e2892ac0f668d41c38381f
 compiler/basicTypes/Name.hs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/compiler/basicTypes/Name.hs b/compiler/basicTypes/Name.hs
index 564e0e3..d9eacd9 100644
--- a/compiler/basicTypes/Name.hs
+++ b/compiler/basicTypes/Name.hs
@@ -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