The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Perl-Critic-Pulp-30
River stage two • 5 direct dependents • 18 total dependents
4 ++
/ Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup

NAME

Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup - don't use C<> markup in a NAME section

DESCRIPTION

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,

    =head1 NAME

    foo - like the C<bar> program     # bad

pod2man uses macros for "C<>" which "man-db"'s lexgrog program doesn't expand, resulting in unattractive description lines from apropos foo like

    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<>" are allowed, because pod2man uses builtin "\fB" etc directives for them, which lexgrog recognises.

As always if you don't care about this you can disable ProhibitBadAproposMarkup from your .perlcriticrc in the usual way,

    [-Documentation::ProhibitBadAproposMarkup]

SEE ALSO

Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName, Perl::Critic::Policy::Documentation::RequirePodSections

HOME PAGE

http://user42.tuxfamily.org/perl-critic-pulp/index.html

COPYRIGHT

Copyright 2009, 2010 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/>.