"Michael T. Richter" wrote:
> Good docs, on the other hand, are very helpful. Even if it strikes an
> old-timer as redundant to explain "unzip = foldr (\(a,b) ~(as,bs) ->
> (a:as,b:bs)) ([],[])" as "this function takes a list of pairs and returns a
> pair of lists", believe it or not this actually helps newbies. At the very
> least it affirms that the newbie's decoding of the line noise "unzip =
> foldr (\(a,b) ~(as,bs) -> (a:as,b:bs)) ([],[])" is correct. This reduces
> uncertainty in the newbie's mind and increases confidence. Increased
> confidence means increased interest. Increased interest means increased
> study. Increased study means potentially a new practitioner of the
> language (and paradigm). This is ultimately good for everyone.
Simon Marlow and I are looking at including a Javadoc
like tool (Haskelldoc) as an extended example for Happy,
for release with soon to appear Happy 1.6. If only we could find
time to write it :-) A Haskelldoc program would take
a Haskell module annotated with stylized comments, and
produce Html pages.
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.
What sort of fields would be useful in a Haskeldoc program?
Comments anyone?
Andy
--
Andy Gill
Principal Project Scientist, Pacific Software Research Center
Department of Computer Science and Engineering
Oregon Graduate Institute of Science & Technology
phone +1 503 748 7451 http://www.cse.ogi.edu/~andy
