Updating documentation

Roman Leshchinskiy rl at cse.unsw.edu.au
Mon Nov 8 05:57:36 EST 2010

On 8 Nov 2010, at 10:29, Johan Tibell <johan.tibell at gmail.com> wrote:

> Like the Javadoc guide, I would encourage people documenting Haskell
> libraries to not hyperlink too much. Only hyperlink identifier if you
> think the reader might want to click on the link for some reason.

Why? I always try to hyperlink identifiers. This provides some syntax highlighting in the comments which I find very useful. Besides, making the reader search for the first occurence of an identifier doesn't sound like a good idea to me. Documentation is rarely read linearly. 


More information about the Libraries mailing list