RFC: hyperlinks in Haddock docs
ross at soi.city.ac.uk
ross at soi.city.ac.uk
Tue Feb 1 06:31:08 EST 2005
On Tue, Feb 01, 2005 at 11:02:45AM -0000, Simon Marlow wrote:
> I'm making some changes to the way Haddock creates links, and I'd like
> to solicit comments on possible alternatives.
>
> The existing approach is for each non-locally-defined identifier in the
> current module, we hyperlink to a module that it was imported from, and
> that (a) actually documents the identifer, and (b) isn't hidden.
>
> [...]
>
> So the new approach is to try to build up a global table of the "best"
> destinations to link to for each entity. The question is how to
> determine "best". Here's my first stab:
>
> - A is better than B if A directly or indirectly imports B
Perhaps it should be the other way round: the lowest non-hidden module
that exports the name (if more than one such, fix on one). This would
need most of GHC.* hidden, which is desirable anyway.
More information about the Glasgow-haskell-users
mailing list