RE: RFC: hyperlinks in Haddock docs

On 01 February 2005 12:48, Ketil Malde wrote:
"Simon Marlow"
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

"Simon Marlow"
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.
But surely in many cases, it would be possible to determine which link is relevant, and go directy? I was under the impression that there were some difficult cases (you mentioned type classes) that tended to mess things up -- I would of course only advocate the indirect approach if it's difficult to do it directly. -kzm -- If I haven't seen further, it is by standing in the footprints of giants
participants (2)
-
Ketil Malde
-
Simon Marlow