[darcs-users] doc idea (Re: [PATCH, RESEND] Eliminate HopefullyPrivate (rename over Hopefully))

[Trent W. Buck]

"Jason Dagit" <dagit at codersbase.com> writes:

> On Sun, Aug 10, 2008 at 8:27 AM, Simon Michael <simon at joyful.com> wrote:
>
>     Some of the type discussion makes my head spin. Something for the
>     wishlist which would help darcs hackers a lot: an index of types, with a
>     short description explaining and justifying each one.
>
>     Some of those descriptions can be harvested from the patch comment. But
>     I guess the best place for brief type docs would be a comment where they
>     are defined ?
>
> If you install haddock 2.0 or newer, you can run:
> make api-doc
>
> This will generate all the haddocks for the source.  This would be a
> great place to see these descriptions.  The current problem is just
> that no one has filled in the descriptions in the source.  Maybe
> eventually an up to date copy of the haddocks can be found on
> darcs.net.

Is this something that people who can read Haskell, but aren't familiar
with Darcs' codebase, can work on?  If so it could go on the "how can I
help?" wiki page.