Data.List documentation improvements

Benjamin Franksen benjamin.franksen at bessy.de
Thu Dec 7 18:46:31 EST 2006


Duncan Coutts wrote:
> On Thu, 2006-12-07 at 09:49 -0800, Iavor Diatchki wrote:
>> Hi,
>> instead of adding examples to the documentation, wouldn't it be better
>> to have a wiki site that documents the libraries, and everyone can add
>> examples there.  I am thinking something along the lines of:
>> http://us2.php.net/manual/en/function.fopen.php
> 
> I added a feature to Haddock to link modules/functions to source code
> and/or to a wiki site (the feature is included in haddock 0.8). So we
> could make something like this work for the standard set of docs on the
> ghc site.
> 
> We'd need to decide on a url scheme and probably find some way of using
> a standard template or pre-creating the wiki pages (I'd assume we'd have
> one per module). 

This sound like a good idea to me, but please make sure that links to
non-existing (or empty) wiki pages are marked (by color or whatever). This
is usually done in wikis so that the reader is spared the frustration of
clicking on dead links...

Cheers
Ben



More information about the Libraries mailing list