[Haskell-cafe] Re: about Haskell code written to be "too smart"

Achim Schneider barsoap at web.de
Thu Mar 26 22:15:59 EDT 2009


wren ng thornton <wren at freegeek.org> wrote:

> Colin Adams wrote:
> > 2009/3/25 wren ng thornton <wren at freegeek.org>:
> > when I look up the Haddock-generated documentation for a function, I
> > DON'T appreciate it if that is in the form of a hyperlink to a
> > research paper.
> > And that occurs in several of the libraries shipped with GHC for
> > instance.
> > 
> > A reference to a research paper is fine to show where the ideas came
> > from, but that is not where the library documentation should be.
> 
> Yeah, that's bad. 'Documentation' like that should be corrected with 
> Extreme Prejudice.
> 
The main problem with research papers as documentation is the papers
usually being outdated wrt. the current library version: Literate
Haskell is utterly underused.


-- 
(c) this sig last receiving data processing entity. Inspect headers
for copyright history. All rights reserved. Copying, hiring, renting,
performance and/or quoting of this signature prohibited.




More information about the Haskell-Cafe mailing list