RFC: hyperlinks in Haddock docs

Ross Paterson ross at soi.city.ac.uk
Wed Feb 2 07:21:58 EST 2005

On Tue, Feb 01, 2005 at 11:02:45AM -0000, Simon Marlow wrote:
> So the new approach is to try to build up a global table of the "best"
> destinations to link to for each entity.

Having a canonical home location for each entity might also help with
another bugbear with Haddock: determining whether two unqualified names
refer to the same entity.  This is impossible at present because Haddock
doesn't show qualified names (because doing so would be too cumbersome)
and anyway the defining module is often hidden.  It's not clear which of
the documented catch functions are Control.Cuncurrent.catch, and which are
System.IOError.catch.  With the new scheme, documentation for an entity in
a module other than its home could include a cross-reference to its home.

More information about the Glasgow-haskell-users mailing list