RFC: hyperlinks in Haddock docs

Simon Marlow simonmar at microsoft.com
Tue Feb 1 10:22:18 EST 2005


On 01 February 2005 12:48, Ketil Malde wrote:

> "Simon Marlow" <simonmar at microsoft.com> writes:
> 
>> There are some problems with the existing approach.  It doesn't cope
>> well with instances: instances might refer to types/classes not below
>> the current module in the hierarchy.  Also you might import an entity
>> from a "hidden" module, but actually want to hyperlink to another
>> module 
> 
>> Thoughts?  Better ideas?
> 
> If it turns out to be difficult to determine where to link, one option
> could be to link to a separate table on the same page, listing the
> candidates?

Hmm, I'm not sure that would be practical.  Lots of entities are
exported from more than one place, especially Prelude entities.  You'd
have a table on almost every single page listing Bool, Maybe, Int, etc.

You could link to the index, I suppose - that lists all the places you
can get a particular entity.  I'm not sure you want to make two clicks
to follow a link every time though.

Cheers,
	Simon


More information about the Glasgow-haskell-users mailing list