[GHC] #13147: Formatting is broken in Exceptions section of GHC.Prim haddock

[GHC]

#13147: Formatting is broken in Exceptions section of GHC.Prim haddock
-------------------------------------+-------------------------------------
        Reporter:  chris-martin      |                Owner:
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Prelude           |              Version:  8.0.1
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by RyanGlScott):

 Yikes. Further complicating this is that the Haddocks for `GHC.Prim`
 aren't written in a Haskell file, but rather a text file
 `compiler/prelude/primops.txt.pp` that is compiled to an `.hs` file. I
 suspect that this process causes the Note (which should rightly be a
 comment not visible to Haddock readers) to be misinterpreted as a section
 description, see
 http://git.haskell.org/ghc.git/blob/38374caa9d6e1373d1b9d335d0f99f3664931fd9:/compiler/prelude/primops.txt.pp#l1944
 .

 A simple workaround would be to move the Note so that it isn't immediately
 beneath a `section`, //à la// `Note [dataToTag#]` (see
 http://git.haskell.org/ghc.git/blob/38374caa9d6e1373d1b9d335d0f99f3664931fd9:/compiler/prelude/primops.txt.pp#l2602).
 Chris, would you care to take this up?

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/13147#comment:1>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler