Updating documentation

Sittampalam, Ganesh ganesh.sittampalam at credit-suisse.com
Mon Nov 8 05:36:53 EST 2010

Johan Tibell 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. For
> example, only hyperlink an identifier the first time it's mention in
> a piece of documentation. Avoid hyperlinking standard, well-know
> identifiers such as Int or String.     

That feels to me like a rule that would be better applied by the
documentation tool, than by the individual writing the documentation.
Especially as the syntax is more lightweight than in Java, it's so much
easier to just automatically do it for everything than to stop and think
each time.


Please access the attached hyperlink for an important electronic communications disclaimer: 

More information about the Libraries mailing list