Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2013-01-18 Thread Ricardo Signes
* Marc Green pongu...@gmail.com [2012-02-19T16:19:08]
 When given the following input, Pod::Simple does not warn that the [text]
 portion of the 2nd and 3rd =item is invalid.
 
 =over
 =item a definition
 some text
 =item *
 a bullet
 =item 1
 a number
 =back
 
 [perlpodspec cited]
 
 I am not sure why it doesn't warn in this situation, but does warn for
 other =item type mismatches.

This seemed to go nowhere, but was brought up to help get Pod::Checker using
Pod::Simple.

I hope we can agree that if the test results bit gets sorted out, we're in
favor of this warning..?

-- 
rjbs


signature.asc
Description: Digital signature


Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2013-01-18 Thread David E. Wheeler
On Jan 18, 2013, at 7:31 AM, Ricardo Signes perl@rjbs.manxome.org wrote:

 I hope we can agree that if the test results bit gets sorted out, we're in
 favor of this warning..?
 
 I have submitted https://github.com/theory/pod-simple/pull/44

+1. Will merge it if there are no objections.

 I also had the idea, mentioned in the commits, that we could consider 
 replacing
 the XML output for testing with JSON output.  This would make it easier to 
 test
 subsections and identify structural differences, since we have a JSON parser 
 in
 core but not an XML parser.

Good idea, though it will require that older versions of Perl install a JSON 
parser just to run the tests…

David



Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2013-01-18 Thread Ricardo Signes
* David E. Wheeler da...@justatheory.com [2013-01-18T12:33:52]
 Good idea, though it will require that older versions of Perl install a JSON
 parser just to run the tests…

I believe it could be bundled, and would be worth the hassle.  Maybe. :-)

-- 
rjbs


signature.asc
Description: Digital signature


Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2013-01-18 Thread Karl Williamson

On 01/18/2013 10:33 AM, David E. Wheeler wrote:

On Jan 18, 2013, at 7:31 AM, Ricardo Signes perl@rjbs.manxome.org wrote:


I hope we can agree that if the test results bit gets sorted out, we're in
favor of this warning..?


I have submitted https://github.com/theory/pod-simple/pull/44


+1. Will merge it if there are no objections.


+1



Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2013-01-18 Thread David E. Wheeler
On Jan 18, 2013, at 10:09 AM, Ricardo Signes perl@rjbs.manxome.org wrote:

 I believe it could be bundled, and would be worth the hassle.  Maybe. :-)

Well, if it's a hassle someone else wants, great! :-)

David



Re: Pod::Simple doesn't warn when the text of a definition =item matches /[\*\d]/; and a fix to this bug

2012-02-20 Thread Sean M. Burke

On 02/19/2012 02:19 PM, Marc Green wrote:

Hello Pod People,

When given the following input, Pod::Simple does not warn that the
[text] portion of the 2nd and 3rd =item is invalid.


In passing, I'll note that the =over ... =item ... =back code was some 
of the hardest notions/code in perlpodspec/Pod::Simple.


And so: If there's points where you are baffled by why it doesn't emit 
warnings, or does when you think it shouldn't-- well, as H.L. Mencken 
often said to everyone who asked him about anything:  You may be right!




When I was coding up this =item-etc stuff, it took long bouts of 
code-wrestling to get tests to start passing, and commenting out some 
while I was working on one thing, then commenting them back in, etc.


I was straining my meaty meaty brain just to get things to go from it 
works! to finally it works!... so I probably often (and 
inconsistently) slipped up and forgot that some of the DWIM that I 
needed to make it work was minor DWIM and I let it go, versus 
situations that needed so much DWIM that it should emit a 
warning-or-summink.

Up to you.


Of course, I think the prime consideration for all situations where 
Pod::Simple didn't use to warn but now does, is: don't turn 
search.cpan.org, into a giant garden of THIS DOCUMENT HAS TROUBLE! 
warnings (or the same for reading the docs in a core dist of Perl, or 
for highly-used modules like LWP, DBI, etc).