[Haskell-cafe] Sparse documentation

Duncan Coutts duncan.coutts at worc.ox.ac.uk
Tue Jul 3 16:12:59 EDT 2007


On Tue, 2007-07-03 at 15:11 -0400, Brent Yorgey wrote:
> 
>         Is there a reason why the documentation for virtually every
>         module in
>         Control.Monad simply begins with a line that says
>         
>           "Inspired by some paper (http://www.ogi.edu/csee/~mpj/)"
> 
> It's probably because it was felt that the paper itself is better
> documentation than anything that could be written in the comments.  Of
> course, this may or may not be actually true.  It just seems to be a
> particular quirk of the way the Haskell community generates,
> disseminates, and consumes information. 

Actually, the code was documented in comments in the code, just not in
haddock format. :-(

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/

Duncan




More information about the Haskell-Cafe mailing list