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: 82706
Status: resolved
Priority: 0/
Queue: Pod-Simple
People
Owner: Nobody in particular
Requestors: RWSTAUNER [...] cpan.org
tsibley [...] cpan.org
Cc:
AdminCc:
Bug Information
Severity: Important
Broken in: 3.23
Fixed in: 3.24

History Show all quoted text
  Mon Jan 14 23:45:30 2013 RWSTAUNER [...] cpan.org - Ticket created
Subject: TOC/Index strips code spans and shows relatively empty items
The Table of Contents and/or Index at the top of the pod (generated by Pod::Simple::XHTML, at least) strips out C<> spans and either includes whatever's left or some sort of fallback. Is this necessary? Would it be reasonable to strip the codes and just use the text as the item text? I'm sorry, I've lost the link to the first example (there was an App that had C<--opt> and I think they showed as "no text" or something like that), but IPC::Run3 is another one: the item after DESCRIPTION is something like "C<a>, Cb>, C<c>" but the item in the TOC shows only the commas in between: ", , ," I haven't had a chance to investigate the issue yet but I wanted to document if before I forgot again. Is there any reason the TOC couldn't just be "a, b, c" for the above example?
  Tue Jan 22 13:21:19 2013 tsibley [...] cpan.org - Correspondence added
I'm running into this as well on <http://bestpractical.com/rt/docs/latest/initialdata.html> which is generated from <https://raw.github.com/bestpractical/rt/stable/docs/initialdata.pod>. On #metacpan, David suggested this was the offending commit: https://github.com/theory/pod-simple/commit/da6313 It's odd that =headX is treated as verbatim though.
  Tue Jan 22 13:21:20 2013 The RT System itself - Status changed from 'new' to 'open'
  Tue Jan 22 13:22:21 2013 tsibley [...] cpan.org - Requestor TSIBLEY added
  Tue Jan 22 13:33:37 2013 david [...] justatheory.com - Correspondence added
Subject: Re: [rt.cpan.org #82706] TOC/Index strips code spans and shows relatively empty items
Date: Tue, 22 Jan 2013 10:33:23 -0800
To: bug-Pod-Simple [...] rt.cpan.org
From: "David E. Wheeler" <david [...] justatheory.com>
What happens if you turn on codes_in_verbatim() yourself? David
  Tue Jan 22 17:12:27 2013 trs [...] bestpractical.com - Correspondence added
Subject: Re: [rt.cpan.org #82706] TOC/Index strips code spans and shows relatively empty items
Date: Tue, 22 Jan 2013 14:12:25 -0800
To: bug-Pod-Simple [...] rt.cpan.org
From: Thomas Sibley <trs [...] bestpractical.com>
On 01/22/2013 10:33 AM, david@justatheory.com via RT wrote: Show quoted text
> What happens if you turn on codes_in_verbatim() yourself?
Same result, presumably because =headN isn't verbatim. Attached is a patch against git master which adds tests demonstrating the regression. It's not quite useful as-is for a bisect since the expected behaviour of HTML in the TOC changed. You'd have to create a test file for each side of that boundary.

Message body is not shown because sender requested not to inline it.

  Tue Jan 22 17:18:12 2013 trs [...] bestpractical.com - Correspondence added
Subject: Re: [rt.cpan.org #82706] TOC/Index strips code spans and shows relatively empty items
Date: Tue, 22 Jan 2013 14:18:10 -0800
To: bug-Pod-Simple [...] rt.cpan.org
From: Thomas Sibley <trs [...] bestpractical.com>
And doing that bisect points to 29306b7 as the culprit.
  Wed Jan 23 19:01:21 2013 tsibley [...] cpan.org - Correspondence added
I've fixed this bug in a pull request: https://github.com/theory/pod- simple/pull/46 If easily possible, I'd appreciate a new release so I can run a released version. :)
  Wed Jan 23 19:02:35 2013 tsibley [...] cpan.org - Correspondence added
Whups, that link got busted: https://github.com/theory/pod-simple/pull/46
  Wed Jan 23 19:02:59 2013 tsibley [...] cpan.org - Subject changed from 'TOC/Index strips code spans and shows relatively empty items' to '[PATCH] TOC/Index strips code spans and shows relatively empty items'
  Wed Jan 23 19:02:59 2013 tsibley [...] cpan.org - Severity Important added
  Wed Jan 23 19:02:59 2013 tsibley [...] cpan.org - Broken in 3.23 added
  Wed Feb 13 17:48:58 2013 dwheeler [...] cpan.org - Status changed from 'open' to 'patched'
  Fri Feb 15 15:44:28 2013 dwheeler [...] cpan.org - Status changed from 'patched' to 'resolved'
  Fri Feb 15 15:44:29 2013 dwheeler [...] cpan.org - Fixed in 3.24 added