Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup - don't use C<> markup in a NAME section
This policy is part of the Perl::Critic::Pulp addon. It asks you not to write C<> markup in the NAME section of the POD because it comes out badly in man's "apropos" database. For example,
Perl::Critic::Pulp
=head1 NAME foo - like the C<bar> program # bad
pod2man formats "C<>" using nroff macros which "man-db"'s lexgrog program doesn't expand, resulting in unattractive description lines from apropos like
pod2man
lexgrog
apropos
foo - like the *(C`bar*(C' program
Man's actual formatted output is fine, and the desired text is in there, just surrounded by "*(C" bits. On that basis this policy is low priority and under the "cosmetic" theme (see "POLICY THEMES" in Perl::Critic).
The NAME section is everything from "=head1 NAME" to the next "=head1". Other markup like "B<>", "I<>" and "F<>" is allowed because pod2man uses builtin "\fB" etc directives for them, which lexgrog recognises.
If want markup in the NAME line, perhaps if printed output is more important than apropos, then you can always disable from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),
[-Documentation::ProhibitBadAproposMarkup]
Or in an individual file with the usual ## no critic
## no critic
## no critic (ProhibitBadAproposMarkup)
though if the NAME part is after an __END__ token then Perl::Critic 1.112 or higher is required (and the annotation must be before the __END__).
__END__
Perl::Critic
Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName, Perl::Critic::Policy::Documentation::RequirePodSections, Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup
man(1), apropos(1), lexgrog(1)
http://user42.tuxfamily.org/perl-critic-pulp/index.html
Copyright 2009, 2010, 2011 Kevin Ryde
Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.
To install Perl::Critic::Pulp, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Critic::Pulp
CPAN shell
perl -MCPAN -e shell install Perl::Critic::Pulp
For more information on module installation, please visit the detailed CPAN module installation guide.