Ticket #112 (closed defect: fixed)

Opened 5 years ago

Last modified 2 years ago

references to names with '#' in them do not work in markup

Reported by: duncan Owned by:
Priority: major Milestone:
Version: 2.4.2 Keywords:
Cc:

Description

For example from the ByteString? docs:

-- | /O(1)/ 'unsafePackAddressLen' provides constant-time construction of
-- 'ByteStrings' which is ideal for string literals. It packs a sequence
-- of bytes into a 'ByteString', given a raw 'Addr#' to the string, and
-- the length of the string.

Haddock copes fine with that type in the type signature, but not a reference in the markup.

Change History

Changed 4 years ago by waern

  • status changed from new to closed
  • resolution set to fixed
  • milestone changed from 2.5.0 to 2.8.0

Fixed by this patch:

Sat Apr 10 12:46:14 CEST 2010  David Waern <david.waern@gmail.com>      
  * Fix #112
  
  No link was generated for 'Addr#' in a doc comment. The reason was simply that
  the identifier didn't parse. We were using parseIdentifier from the GHC API,
  with a parser state built from 'defaultDynFlags'. If we pass the dynflags of
  the module instead, the right options are turned on on while parsing the
  identifer (in this case -XMagicHash), and the parse succeeds.

Changed 2 years ago by anonymous

  • milestone 2.8.0 deleted

Milestone 2.8.0 deleted

Note: See TracTickets for help on using tickets.