Personal tools

Improving library documentation

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(a page for improving library documentation)
 
(more info)
Line 17: Line 17:
 
-- > [10,9,8,7,6,5,4,3,2,1]
 
-- > [10,9,8,7,6,5,4,3,2,1]
 
--
 
--
  +
[[User:DonStewart|dons]] 00:31, 26 November 2006 (UTC)
  +
  +
Tag your submission with your name by using 4 ~ characters, which will
  +
be expanded to your name and the date.
  +
  +
If you'd like, you can directly submit your suggestion as a darcs patch
  +
via the [http://www.haskell.org/ghc/docs/latest/html/users_guide/bug-reporting.html bug tracking system].
   
 
Please add your comments under the appropriate package:
 
Please add your comments under the appropriate package:

Revision as of 00:31, 26 November 2006

If you find standard library documentation lacking in any way, please log it here. At the minimum record what library/module/function isn't properly documented. Please also suggest how to improve the documentation, in terms of examples, explanations and so on.

Example:

   package base
   Data.List
   unfoldr
   An example would be useful. Perhaps:
       -- A simple use of unfoldr:
       --
       -- > unfoldr (\b -> if b == 0 then Nothing else Just (b, b-1)) 10
       -- >  [10,9,8,7,6,5,4,3,2,1]
       --

dons 00:31, 26 November 2006 (UTC)

Tag your submission with your name by using 4 ~ characters, which will be expanded to your name and the date.

If you'd like, you can directly submit your suggestion as a darcs patch via the bug tracking system.

Please add your comments under the appropriate package:

Contents

1 base

2 network

3 unix

4 QuickCheck