[darcs-users] putting haddocks on http://darcs.net/api-doc

[Jason Dagit]

On Fri, Sep 12, 2008 at 3:12 PM, Eric Kow <kowey at darcs.net> wrote:
> Hi David,
>
> In case this got lost in the recent exchange with Dmitry:
>
> At each push into darcs-stable, I intend to compiling the API
> documentation with make api-doc on my machine and then use
> rsync to transfer it over to darcs.net.  Is this ok with you?

Eric, if we're ready to go this route, then how will we manage the
'testing' of well-formed haddocks?  It seems that we could add
something to the tests would be a good idea.  Or is this something
that we allow to break?  Who will you hold responsibility for fixing
it?

I would hate to see patches get rejected due to typos in haddocks that
prevent haddock from running, but it seems like a stretch to make that
your responsibility to fix them.  If well-formed haddocks are now a
requirement then we should make the test suite check for that so
people get alerted to buggy haddocks before they 'darcs send'.

I'm excited that darcs.net may soon start hosting the up to date
haddocks of the darcs source!

I tend to keep an (outdated) copy on my local machine and use it from
time to time.  I hope others will start finding it useful.  I also
rely heavily on 'make tags' as a way on navigating the source code.

Thanks,
Jason