[GHC] #14653: Text missing in ghc-prim's documentation

[GHC]

#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  (none)
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  libraries         |              Version:  8.2.2
  (other)                            |
      Resolution:                    |             Keywords:  ghc-prim
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Description changed by gallais:

Old description:

> The comment for `reallyUnsafePtrEquality#` visible on
> [https://hackage.haskell.org/package/ghc-prim-0.5.1.1/docs/GHC-
> Prim.html#v:reallyUnsafePtrEquality-35- hackage] gives the impression
> that the function returns `1#` when the two points are not equal.
>
> Looking [https://hackage.haskell.org/package/ghc-
> prim-0.5.1.1/docs/src/GHC.Prim.html#reallyUnsafePtrEquality%23 at the
> source code], the intended comment is the complete opposite.
>
> It seems that haddock ate everything between hashes.

New description:

 The comment for `reallyUnsafePtrEquality#` visible on
 [https://hackage.haskell.org/package/ghc-prim-0.5.1.1/docs/GHC-
 Prim.html#v:reallyUnsafePtrEquality-35- hackage] gives the impression that
 the function returns `1#` when the two pointers are not equal.

 Looking [https://hackage.haskell.org/package/ghc-
 prim-0.5.1.1/docs/src/GHC.Prim.html#reallyUnsafePtrEquality%23 at the
 source code], the intended comment is the complete opposite.

 It seems that haddock ate everything between hashes.

--

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