At 02:43 PM 2003-08-21 -0700, Michael G Schwern wrote:
Test::Pod throws a whole lot of non-errors which I presume are from Pod::Simple. They fall into three categories.

* reporting that =item lists are out of order.

One set of failures is because it doesn't recognize that item lists can start with 0. More generally the problem is not all numbered item lists are supposed to be ordered lists! [...] The POD formatter should be smart enough to decide if it has an ordered list or not.

The telepathic powers of Pod "formatters" (i.e., parser-plus-renderers) are alas limited.


So, sorry, but if people don't want their numbers to be mistaken for item-numbers, they just have to prefix with "#" or whatever to stop the line from being m/^=item\s+\d+\.?\s*$/s. And if they are numbering, then they just have to start at 1 and continue by steps of one.

Stet.


* reporting that you can't have anything between an =over and an =item.

I'm not entirely sure this should be disallowed.  I can't find where
in perlpodspec it is disallowed.

I'm entirely sure this should be disallowed.
It would take too much lookahead (like: potentially a whole document's worth) to have Pod::Simple implement something more telepathic. (Ditto for the first point, in fact.)


It's not a common problem tho, and fixing it for these rare cases would mean abandoning the event-based approach that is quite basic to Pod::Simple, in favor of a more HTML-Tree-like model, where the whole syntax tree sits in memory.

Stet.


* trouble with "C<< >> and C<< >> >>"

This is in lib/Pod/t/basic.pod and apparently someone thought it to be valid. Pod::Simple doesn't like it. I guess Pod::Parser does. I have no opinion on it, just thought you should know.

Ohyeah, t/basic.pod http://search.cpan.org/src/JHI/perl-5.8.1-RC4/lib/Pod/t/basic.pod says:

Lets make sure these work for empty ones too, like C<<  >> and C<< >> >>
(just to be obnoxious)

Pod::Parser and Pod::Simple diverge in how they deal with those degenerate cases. But I don't think it's important.


I'm glad to see they don't diverge on any other points of importance! Thanks for running all these tests!

--
Sean M. Burke    http://search.cpan.org/~sburke/



Reply via email to