develooper Front page | perl.perl5.porters | Postings from February 2013

Re: Recent pod

Thread Previous | Thread Next
From:
David E. Wheeler
Date:
February 25, 2013 22:38
Subject:
Re: Recent pod
Message ID:
F859F77A-70CC-40B8-9DDB-FAEAAD9F059B@justatheory.com
On Feb 25, 2013, at 2:32 PM, Mark Overmeer <mark@overmeer.net> wrote:

> The perlpod manual speaks about a special meaning for '1.', not '1'
> without dot.
> 
>> Either way, this warning has alerted you* to an unexpected
>> inconsistency, and so gives you the opportunity to do something about it.
>> 
>> *Where by "you" I man the maintainer of this module and others that
>> might exhibit a similar problem.
> 
> Of course, there are many work-arounds.  That's not the point.  It's
> the missing point, I think.

perlpodspec:

>            ยท   An "=over" ... "=back" region containing only
>                "m/\A=item\s+\d+\.?\s*\z/" paragraphs, each one (or each group
>                of them) followed by some number of ordinary/verbatim
>                paragraphs, other nested "=over" ... "=back" regions, "=for..."
>                paragraphs, and/or "=begin"..."=end" codes.  Note that the
>                numbers must start at 1 in each section, and must proceed in
>                order and without skipping numbers.
> 
>                (Pod processors must tolerate lines like "=item 1" as if they
>                were "=item 1.", with the period.)

As a result, the type of the list is determined by this method:

  https://github.com/theory/pod-simple/blob/master/lib/Pod/Simple.pm#L556

Best,

David


Thread Previous | Thread Next


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