Documentation Conventions
The only documentation conventions the reader has to know about are:
-
things inside [square brackets] are optional
-
parenthesized lists with the items separated by vertical bars,
(like | this | one) require that you choose one and only one of the
alternatives.
Everything else ought to be explicit. If it isn't, or if you don't
understand it, please bring it to the author's attention, stating
which part you don't understand. There's not a lot of point in my
writing documentation which no-one else can understand. I'd rather
do it right.
Last updated Thu Mar 17 16:58:51 UTC 2005 by <thomas.erskine@sourceworks.com>.
[