[GHC] #15605: Documentation of atomicModifyMutVar# does not show properly

[GHC]

#15605: Documentation of atomicModifyMutVar# does not show properly
-------------------------------------+-------------------------------------
           Reporter:  harendra       |             Owner:  (none)
               Type:  bug            |            Status:  new
           Priority:  normal         |         Milestone:  8.6.1
          Component:  libraries      |           Version:  8.4.3
  (other)                            |
           Keywords:  ghc-prim       |  Operating System:  Unknown/Multiple
       Architecture:                 |   Type of failure:  None/Unknown
  Unknown/Multiple                   |
          Test Case:                 |        Blocked By:
           Blocking:                 |   Related Tickets:
Differential Rev(s):                 |         Wiki Page:
-------------------------------------+-------------------------------------
 The actual documentation in the source is:

 {{{
 -- | Modify the contents of a @MutVar\#@. Note that this isn\'t strictly
 --      speaking the correct type for this function, it should really be
 --      @MutVar# s a -> (a -> (a,b)) -> State# s -> (# State# s, b #)@,
 however
 --      we don\'t know about pairs here.
 }}}

 It actually shows as this in the docs, note the incomplete signature:

 {{{
 Modify the contents of a MutVar#. Note that this isn't strictly speaking
 the correct
 type for this function, it should really be MutVar s -> ( s, b #), however
 we
 don't know about pairs here.
 }}}

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