develooper Front page | perl.perl5.porters | Postings from December 2004

Re: perlpodtut

Thread Previous
From:
Russ Allbery
Date:
December 24, 2004 10:41
Subject:
Re: perlpodtut
Message ID:
87u0qb4jz9.fsf@windlord.stanford.edu
Ronald J Kimball <rjk-perl-p5p@tamias.net> writes:
> On Fri, Dec 24, 2004 at 11:12:05AM +0100, Juerd wrote:

>> =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.

No, the indent specified by =over is the indent of the paragraphs from the
list tags.  12 is right; the intention is to get the method name entirely
in the left-hand margin rather than putting it on a separate line.

The indentation of a list from a heading is determined by the formatter.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>

Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About