[Haskell-cafe] Comments from OCaml Hacker Brian Hurt

David Waern david.waern at gmail.com
Sun Jan 18 16:52:30 EST 2009


2009/1/18 Don Stewart <dons at galois.com>:
> ross:
>> On Sat, Jan 17, 2009 at 09:12:32PM -0500, ajb at spamcop.net wrote:
>> > And FWIW, I agree with everyone who has commented that the documentation
>> > is inadequate.  It'd be nice if there was some way to contribute better
>> > documentation without needing checkin access to the libraries.
>>
>> There is.  The current state of the docs may be viewed at
>>
>>       http://www.haskell.org/ghc/dist/current/docs/libraries/
>>
>> Anyone can check out the darcs repos for the libraries, and post
>> suggested improvements to the documentation to libraries at haskell.org
>> (though you have to subscribe).  It doesn't even have to be a patch.
>>
>> Sure, it could be smoother, but there's hardly a flood of contributions.
>
> I imagine if we set up a wiki-like system where the entire hackage docs
> could be edited, as well as viewed, we would end up with a flood.
>
> A modification to haddock perhaps, that sends edits to generated docs to libraries@ ?

This has come up many times lately. I've created a ticket for it:

  http://trac.haskell.org/haddock/ticket/72

If anyone has suggestions for design or implementation of a system
like this, don't hesitate to post to this ticket!

David


More information about the Haskell-Cafe mailing list