Updating documentation

Johan Tibell johan.tibell at gmail.com
Mon Nov 8 05:41:53 EST 2010

On Mon, Nov 8, 2010 at 12:36 PM, Sittampalam, Ganesh
<ganesh.sittampalam at credit-suisse.com> wrote:
> 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.

In my experience, I don't think there's automatic way to decided where
to link or not. It's really a judgement call (and I sometimes go back
and remove or add hyperlinks). Sometimes I don't hyperlink an
identifier even the first time it's mentioned, for example because it
was hyperlinked in the introduction.

More information about the Libraries mailing list