Kevin Ryde > Perl-Critic-Pulp > Perl::Critic::Policy::Documentation::ProhibitParagraphEndComma

Download:
Perl-Critic-Pulp-88.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  3
View/Report Bugs
Module Version: 88   Source  

NAME ^

Perl::Critic::Policy::Documentation::ProhibitParagraphEndComma - avoid comma at end of section

DESCRIPTION ^

This policy is part of the Perl::Critic::Pulp add-on. It asks you not to end a POD paragraph with a comma.

    Some text,       # bad, meant to be a full-stop?

    Some more text.

Usually such a comma is meant to be a full-stop, or perhaps omitted at the end of a "SEE ALSO" list

    =head1 SEE ALSO

    L<Foo>,
    L<Bar>,          # bad, meant to be omitted?

A paragraph before an =over or a verbatim block can end with a comma, that being taken as introducing a quotation or example,

    For example,     # ok, introduce an example

        foo(1+2+3)

    Or one of,       # ok, introduce an itemized list

    =over

    =item Foo

Disabling

If you don't care about this you can disable ProhibitParagraphEndComma from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),

    [-Documentation::ProhibitParagraphEndComma]

SEE ALSO ^

Perl::Critic::Pulp, Perl::Critic

Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots

HOME PAGE ^

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

COPYRIGHT ^

Copyright 2010, 2011, 2012, 2013, 2014 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/>.

syntax highlighting: