Haddock's -s switch is broken
Simon Marlow
simonmar at microsoft.com
Wed May 4 06:34:36 EDT 2005
On 03 May 2005 15:24, Peter Simons wrote:
> Simon Marlow writes:
>
> > Anyway, in CVS, the argument to -s is transformed as follows:
> >
> > - the string %M is replaced by the module name
> > (with '.' replaced by '/')
> >
> > - the string %F is replaced by the source file name
> >
> > so to get the behaviour of Haddock 0.6, you say 'haddock -s
> <url>/%F'.
>
> Very cool. Adding the '%F' did fix the problem; thanks for
> the pointer.
>
> I am all for having links to the source code wherever
> possible, by the way, I think that's the right direction to
> go. IMHO, the best solution would be generate the pages with
> the source along with the documentation. This approach gets
> rid of most file-name-guessing problems, and it allows for
> nifty features to be added (such as adding hyperlinks in the
> source code, too).
Opinions were divided on whether we should link to the source code at
all. Some people thought that doing so would reduce the incentive for
us to provide good documentation.
There are good arguments on both sides - I don't have a strong opinion
either way.
Cheers,
Simon
More information about the Glasgow-haskell-users
mailing list