1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
=cut
TITLE=Documentation Conventions
DESCRIPTION=documentation conventions for those who don't read manualese
KEYWORDS=documentation,conventions
DOCTOP=index
DOCPREV=faq
DOCNEXT=required
=pod
=head1 Documentation Conventions
The only documentation conventions the reader has to know about are:
=over 4
=item things inside [square brackets] are optional
=item parenthesized lists with the items separated by vertical bars,
(like | this | one) require that you choose one and only one of the
alternatives.
=back 4
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.
|
