simonmar at microsoft.com
Fri Dec 10 04:31:24 EST 2004
On 09 December 2004 21:57, John Tromp wrote:
> Simon Marlow wrote:
>> Thanks. Data.Array.Base is a "hidden" module - we don't expose its
>> documentation, but unfortunately Haddock sometimes still generates
>> links to it, when it can't find anywhere better to link to. This is
>> a bug, but unfortunately it's a pretty deep bug - Haddock would need
>> to be able to link to modules outside the imported scope of the
>> current module, which it currently can't do.
>> Fortunately there's often a workaround in the form of rearranging the
>> imports of a module to expose the correct linking destinations to
>> Haddock. I'll do a sweep over the docs before we release GHC 6.4 and
>> make sure we don't have any dangling links of this kind.
> Does Haddock create the webpages on demand or as a batchjob?
A batch job.
> In the latter case one could run a script that goes over the webpages
> and reports on all broken links, which can then be fixed either
> manually or perhaps within the same script. I imagine that every
> class, type and function is documented somewhere. At least that was
> the case for all the broken links I ran into...
Yes we could do this, but I'd prefer to fix the problem in Haddock
itself. A script can't reliably determine the right place to link to -
there might be multiple IArrays, for example.
More information about the Libraries