Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Pod-Simple CPAN distribution.

Report information
The Basics
Id: 84626
Status: rejected
Priority: 0/
Queue: Pod-Simple
People
Owner: Nobody in particular
Requestors: dolmen [...] cpan.org
mschwern [...] cpan.org
Cc:
AdminCc:
Bug Information
Severity: (no value)
Broken in: 3.26
Fixed in: (no value)

History Show all quoted text
  Sun Apr 14 11:28:11 2013 mschwern [...] cpan.org - Ticket created
Subject: Remove restriction on "=item $number"
Pod::Simple has begun issuing the error "Expected text after =item, not a number" when =item numbers are out of order.  For example from Regexp::Assemble documenting bit fields...

=over 8

=item 0

Off. Turns off all debugging output.

=item 1

Add. Trace the addition of patterns.

=item 2

Reduce. Trace the process of reduction and assembly.

=item 4

Lex. Trace the lexing of the input patterns into its constituent
tokens.

=back

This is strictly disallowed in 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.

However, it's IMO a silly restriction to say that there's one and only one use for numbered items and that is an ordered, sequential list starting at 1.

I'm not sure who's in charge of perlpodspec, but the error is coming from Pod::Simple.
  Mon Apr 15 11:56:27 2013 dwheeler [...] cpan.org - Correspondence added
Subject: Re: [rt.cpan.org #84626] Remove restriction on "=item $number"
Date: Mon, 15 Apr 2013 08:56:14 -0700
To: bug-Pod-Simple [...] rt.cpan.org
From: "David E. Wheeler" <dwheeler [...] cpan.org>
On Apr 14, 2013, at 8:28 AM, "Michael G Schwern via RT" <bug-Pod-Simple@rt.cpan.org> wrote: Show quoted text
> I'm not sure who's in charge of perlpodspec, but the error is coming from > Pod::Simple.
Honestly, I think this issue needs to be raised on pod-people. David
  Mon Apr 15 11:56:27 2013 The RT System itself - Status changed from 'new' to 'open'
  Mon Apr 15 12:00:04 2013 dwheeler [...] cpan.org - Status changed from 'open' to 'stalled'
  Sat Oct 05 05:00:13 2013 dolmen [...] cpan.org - Requestor DOLMEN added
  Sat Oct 05 05:04:22 2013 dolmen [...] cpan.org - Correspondence added
Le 2013-04-14 17:28:11, MSCHWERN a écrit : Show quoted text
> Pod::Simple has begun issuing the error "Expected text after =item, > not a > number" when =item numbers are out of order. For example from > Regexp::Assemble > documenting bit fields... > > =over 8 > > =item 0 > > Off. Turns off all debugging output. > > =item 1 > > Add. Trace the addition of patterns. > > =item 2 > > Reduce. Trace the process of reduction and assembly. > > =item 4 > > Lex. Trace the lexing of the input patterns into its constituent > tokens. > > =back > > This is strictly disallowed in perlpodspec...
Workaround: use formatting code around the number to tranform the numbered list in a list where entries are text. Example: =item C<0> -- Olivier Mengué - http://perlresume.org/DOLMEN
  Sat Oct 05 05:04:22 2013 The RT System itself - Status changed from 'stalled' to 'open'
  Mon Oct 07 13:25:40 2013 dwheeler [...] cpan.org - Correspondence added
Yeah, I'm not inclined to remove the warning at this point. It's best to try to avoid invalid numbering, and one can eliminate the warning by one of several methods if one really does require that the first item be a number but not a numbered list.
  Mon Oct 07 13:25:41 2013 dwheeler [...] cpan.org - Status changed from 'open' to 'rejected'