Front page | perl.perl5.porters |
Postings from December 2004
December 24, 2004 13:07
Message ID: 20041224171959.GD9912@c4.convolution.nl
Ronald J Kimball skribis 2004-12-24 11:56 (-0500):
> > =item SYNOPSIS
> > means "see together" and shows example usage.
> A synopsis is a brief summary. The derivation of the word doesn't seem
> useful here.
Overview is more correct, I think. And because in typical POD documents,
the DESCRIPTION part has the summary, I don't think the word "summary"
should be mentioned as the explanation of SYNOPSIS.
I like the derivation.
> > =head2 Lists
> > An example is much clearer than an explanation here.
> > =head2 Methods
> > =over 12
> I think that should be =over 4, since the example shows an indent of 4 from
> the heading:
> > Methods
> > "new" Returns a new My::Module object.
> > "as_string" Returns a stringified representation of the
> > object. This is mainly for debugging purposes.
1234 # Mail quotes
1234 # Standard indentation in perlpodtut
12 # Indentation for =head2
1234 # Indentation for =over
123456789_12 # Indentation for paragraph text
# width is number after =over
The list indent is by default 4 in text2pod. This can be overridden with
-i or --indent. This indent has nothing to do with the number after