[Haskell-cafe] Sparse documentation

[Claus Reinke]

the references have not been updated, it seems. but once you've 
used the name "Mark P Jones", mentioned next to the link, to 
google for a current url for his publications page, you'll

(a) find a treasure-trove of haskell papers
    http://web.cecs.pdx.edu/~mpj/

(b) be able to submit a fix for the documentation bug to the
    library maintainer, which 'ghc-pkg describe mtl' lists as
    libraries at haskell.org

(c) indicate to the maintainer what additional information 
    you would find helpful in the haddocks, and perhaps help
    to get it there (several libraries have acquired more directly
    useful haddocks this way, including parts of the monad libs,
    with the permission of paper and tutorial authors, but there 
    are still quite a few gaps waiting to be filled)

(did i mention that putting bug reports in parentheses in emails
 is not the best way to attract attention, get the bug recorded, 
 or fixed?-)

claus

----- Original Message ----- 
From: "Andrew Coppin" <andrewcoppin at btinternet.com>
To: <haskell-cafe at haskell.org>
Sent: Tuesday, July 03, 2007 7:38 PM
Subject: [Haskell-cafe] Sparse documentation


> 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/)"
> 
> and then just shows you a bunch of type signatures, without telling you 
> *anything* about what the module is supposed to be for, or what all 
> these classes, types, methods and functions are meant to *do*?
> 
> I'm currently struggling with a really knotty problem, and the last 
> thing I need is unhelpful documentation. :-S
> 
> (Did I mention that that URL goes nowhere?)
> 
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe