RFC: hyperlinks in Haddock docs

Simon Marlow simonmar at microsoft.com
Fri Feb 4 07:03:49 EST 2005


On 02 February 2005 12:22, Ross Paterson wrote:

> 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. 

This is a good idea, I've put it on the TODO list.

Cheers,
	Simon


More information about the Glasgow-haskell-users mailing list