A reasonable question from Michael. Can someone who’s more deeply involved in library development answer? Cc haskell-cafe. An easy “here’s how to contribute” wiki page would be great. Michael: I think we are talking about library documentation rather than documentation of GHC’s internals. But your question stands. Thanks Simon From: Michael T. Richter [mailto:ttmrichter@gmail.com] Sent: 04 July 2007 08:24 To: Simon Peyton-Jones Cc: haskell-cafe@haskell.org Subject: RE: [Haskell-cafe] Sparse documentation On Wed, 2007-04-07 at 08:03 +0100, Simon Peyton-Jones wrote: | Fortunately, some kind soul has gone through and converted the | documentation to haddock format: | http://hackage.haskell.org/trac/ghc/ticket/1410 | | So it'll all appear in the html docs in the next version. In the mean | time one can look at the haddock comments in the source: | http://darcs.haskell.org/packages/mtl/Control/Monad/ Furthermore, you can always get the GHC HEAD documentation here http://www.haskell.org/ghc/dist/current/docs
From there you can get to Control.Monad, which indeed shows at least some documentation.
Simon, if the less-talented among us (like me) want to contribute to GHC's docs -- and especially documenting the libraries -- what's the best way to go about this? I'm not too comfortable with the notion of just going into GHC's guts and Haddocking the comments, contributing patches willy-nilly because I'd not be certain I did the job right, that I explained things correctly where I had to amplify, etc. Is there some kind of documentation team we poor souls could interact with to assist?
--
Michael T. Richter