Opened 13 months ago

Last modified 13 months ago

#15605 new bug

Documentation of atomicModifyMutVar# does not show properly

Reported by: harendra Owned by:
Priority: normal Milestone: 8.6.1
Component: libraries (other) Version: 8.4.3
Keywords: ghc-prim Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

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.

Change History (1)

comment:1 Changed 13 months ago by harendra

There are other cases as well, perhaps all cases in which "#" is used more than once in the doc paragraphs should be examined. The documentation between a pair of "#" gets eaten up. For example, the documentation of compactContains# and compactContainsAny# also does not show correctly.

Note: See TracTickets for help on using tickets.