Skip Menu |

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

Report information
The Basics
Id: 33020
Status: resolved
Priority: 0/
Queue: Pod-Parser
People
Owner: Marek.Rouchal [...] gmx.net
Requestors: nigel.metheringham [...] Dev.intechnology.co.uk
Cc:
AdminCc:
Bug Information
Severity: Normal
Broken in: 1.35
Fixed in: 1.36

History Show all quoted text
  Fri Feb 08 12:02:46 2008 nigel.metheringham [...] Dev.intechnology.co.uk - Ticket created
Subject: Pod::Usage always uses SYNOPSIS section. Perl::Critic recommends USAGE section
Pod::Usage uses the SYNOPSIS section to get usage information. The Pre::Critic policy Perl::Critic::Policy::Documentation::RequirePodSections favours a USAGE section for scripts. Maybe a case could be made for making Pod::Usage able to take a parameter for the appropriate section and/or have a default of looking in both SYNOPSIS and USAGE.
  Fri Jan 16 04:30:42 2009 Marek.Rouchal [...] gmx.net - Taken
  Fri Jan 16 04:40:00 2009 Marek.Rouchal [...] gmx.net - Correspondence added
Thanks for the input. Pod-Parser-1.36 will look for both SYNOPSIS and USAGE sections. No need to have both in one .pod or .pm - however I need to support both the traditional (manpage style) SYNOPSIS and the more modern USAGE as suggested by perlcritic. Section picking can be done by using -verbose => 99, -sections => 'USAGE' -Marek
  Fri Jan 16 04:40:01 2009 The RT System itself - Status changed from 'new' to 'open'
  Tue Jan 20 09:41:41 2009 Marek.Rouchal [...] gmx.net - Status changed from 'open' to 'resolved'
  Tue Jan 20 09:41:42 2009 Marek.Rouchal [...] gmx.net - Fixed in 1.36 added