Bug #44242 for DBD-Pg: [Patch] POD typos

Tue Mar 17 09:10:45 2009 frank.wiegand [...] gmail.com - Ticket created

Subject:

[Patch] POD typos

Hi, the attached patch (against the 2.11.8 CPAN distribution) fixes some POD errors in Pg.pm. Thanks, Frank

Subject:

diff

Download diff
application/octet-stream 1.9k

Message body not shown because it is not plain text.

Wed Mar 18 10:53:03 2009 greg [...] turnstep.com - Correspondence added

Thanks, fixed in r12612. Note that only the wrapping around undef was changed: the other bits were correct as they were.

Wed Mar 18 10:53:03 2009 The RT System itself - Status changed from 'new' to 'open'

Wed Mar 18 10:53:04 2009 greg [...] turnstep.com - Status changed from 'open' to 'resolved'

Thu Mar 19 03:19:21 2009 frank.wiegand [...] gmail.com - Correspondence added

Subject:	Re: [rt.cpan.org #44242] [Patch] POD typos
Date:	Wed, 18 Mar 2009 17:12:07 +0100
To:	bug-DBD-Pg [...] rt.cpan.org
From:	Frank Wiegand <frank.wiegand [...] gmail.com>

Hi, Am Mittwoch, den 18.03.2009, 10:53 -0400 schrieb Greg Sabino Mullane via RT: Show quoted text

> <URL: https://rt.cpan.org/Ticket/Display.html?id=44242 > > > Thanks, fixed in r12612. Note that only the wrapping around undef was > changed: the other bits were correct as they were.

% podchecker Pg.pm *** ERROR: unresolved internal link 'placeholders' at line 3073 in file Pg.pm *** ERROR: unresolved internal link 'pg_expand_array__boolean__read_only_' at line 3979 in file Pg.pm *** ERROR: unresolved internal link 'pg_bool_tf__boolean_' at line 4104 in file Pg.pm Pg.pm has 3 pod syntax errors. % module_info Pod::Checker | grep Version Version: 1.45 Thanks, Frank

Thu Mar 19 03:19:21 2009 The RT System itself - Status changed from 'resolved' to 'open'

Sat Mar 21 13:27:04 2009 greg [...] turnstep.com - Taken

Sat Mar 21 13:35:07 2009 greg [...] turnstep.com - Correspondence added

Interesting. There is definitely a disconnect here between two tools, podchecker and pod2html. I've always used the latter as a guide to well-formedness, as that's what gets used by cpan.org to make theur pages (I think). Here's what happens with the current Pg.pm on podchecker: Show quoted text

> podchecker Pg.pm

*** ERROR: unresolved internal link 'pg_expand_array__boolean__read_only_' at line 3979 in file Pg.pm *** ERROR: unresolved internal link 'pg_bool_tf__boolean_' at line 4104 in file Pg.pm Pg.pm has 2 pod syntax errors. But if we "fix" those by removing the underscore hack, pod2html is no longer able to find the correct links: Show quoted text

> pod2html Pg.pm > /dev/null

/usr/local/bin/pod2html: Pg.pm: cannot resolve L<pg_expand_array> in paragraph 930. /usr/local/bin/pod2html: Pg.pm: cannot resolve L<pg_bool_tf> in paragraph 959. Not sure at the moment what the correct solution is, but any solution that makes podchecker happy must also work for pod2html. Suggestions welcome. :)

Sat Mar 21 15:42:16 2009 dwheeler [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #44242] [Patch] POD typos
Date:	Sat, 21 Mar 2009 15:41:38 -0400
To:	bug-DBD-Pg [...] rt.cpan.org
From:	"David E. Wheeler" <dwheeler [...] cpan.org>

On Mar 21, 2009, at 1:35 PM, Greg Sabino Mullane via RT wrote: Show quoted text

> Queue: DBD-Pg > Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=44242 > > > Interesting. There is definitely a disconnect here between two tools, > podchecker and pod2html. I've always used the latter as a guide to > well-formedness, as that's what gets used by cpan.org to make theur > pages (I think). Here's what happens with the current Pg.pm on > podchecker: >

>> podchecker Pg.pm

> *** ERROR: unresolved internal link > 'pg_expand_array__boolean__read_only_' at line 3979 in file Pg.pm > *** ERROR: unresolved internal link 'pg_bool_tf__boolean_' at line > 4104 > in file Pg.pm > Pg.pm has 2 pod syntax errors. > > But if we "fix" those by removing the underscore hack, pod2html is no > longer able to find the correct links: >

>> pod2html Pg.pm > /dev/null

> /usr/local/bin/pod2html: Pg.pm: cannot resolve L<pg_expand_array> in > paragraph 930. > /usr/local/bin/pod2html: Pg.pm: cannot resolve L<pg_bool_tf> in > paragraph 959. > > Not sure at the moment what the correct solution is, but any solution > that makes podchecker happy must also work for pod2html. Suggestions > welcome. :) >

I think you want to use Pod::Simple to generate the HTML; that's what search.cpan.org uses. When I do it, the HTML look like this: <h3><a class='u' href='#___top' title='click to go to top of document' name="pg_expand_array_(boolean)" Show quoted text

><b>pg_expand_array</b> (boolean)</a></h3>

So I think what you want is: L<pg_expand_array|/pg_expand_array_(boolean)> Best, David

Sat Mar 21 17:43:17 2009 greg [...] turnstep.com - Correspondence added

Show quoted text

> So I think what you want is: > > L<pg_expand_array|/pg_expand_array_(boolean)>

Thanks, good to know, and that does work for Pod::Simple::HTML, but it still fails podchecker. At any rate, it's better than what we had before, so I'm making the change until/if we find a better solution that makes all the modules happy.

Wed Mar 25 11:14:36 2009 greg [...] turnstep.com - Correspondence added

Considering this resolved. Please reopen if it is causing problems for any in-use POD tools.

Wed Mar 25 11:14:37 2009 greg [...] turnstep.com - Status changed from 'open' to 'resolved'

Tue Apr 07 16:30:48 2009 greg [...] turnstep.com - Fixed in 2.12.0 added