Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots - don't end a paragraph with two dots


Perl-Critic-Pulp documentation  | view source Contained in the Perl-Critic-Pulp distribution.

Index


NAME

Top

Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots - don't end a paragraph with two dots

DESCRIPTION

Top

This policy is part of the Perl::Critic::Pulp|Perl::Critic::Pulp addon. It asks you not to end a POD paragraph with two dots,

    Some sentence..                 # bad

This is a surprisingly easy typo, but of course is entirely cosmetic and on that basis this policy is lowest priority and under the "cosmetic" theme (see POLICY THEMES in Perl::Critic).

A three or more dot ellipsis is fine,

    And some more of this ...       # ok

Anything within a paragraph is fine,

    Numbers 1 .. 10 are handled.    # ok

Only text paragraphs are checked, verbatim paragraphs can end with anything,

    This is an example,

        example_code (1 ..          # ok
                      10);

There might be other dubious paragraph endings to pick up, but things like ";." or ":." can arise from code or smiley faces, so at the moment only two dots are bad.

Disabling

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

    [-Documentation::ProhibitParagraphTwoDots]

A ## no critic directive works in recent Perl::Critic, though generally must be before any __END__ token.

SEE ALSO

Top

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

HOME PAGE

Top

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

COPYRIGHT

Top


Perl-Critic-Pulp documentation  | view source Contained in the Perl-Critic-Pulp distribution.