Re: Haskell Wish list: library documentation

[Michael T. Richter]

At 05:54 PM 9/8/99 , Andy Gill wrote:
>I've been playing will possible formats of such documentation.
>Have a look at http://www.cse.ogi.edu/~andy/gooddoc.htm
>for what I'm currently thinking of.

This is what I would classify as "reasonable documentation" based upon my
current level of Haskell expertise (vanishingly small).  It clearly and
succinctly illustrates what unzip does and provides clear and simple
examples, including its use with other features of the library and
language.  (I assume that if I knew more about infinite lists, lazy
evaluation and the take function I'd be even more impressed.:-)

>What sort of fields would be useful in a Haskeldoc program?

I don't know Javadoc very well, so I don't know how to answer this.  What
fields do you have right now?

And, of course, Haskelldoc will only be of use if people actually document
their code.  I know that I comment obsessively by my colleagues' standards
here and I'm still uncomfortable with the level of documentation I provide
in my source....  :-)

BTW, what is Happy?

--
Michael T. Richter    <[EMAIL PROTECTED]>    http://www.igs.net/~mtr/
          PGP Key: http://www.igs.net/~mtr/pgp-key.html
PGP Fingerprint: 40D1 33E0 F70B 6BB5 8353 4669 B4CC DD09 04ED 4FE8