| Perl-Critic-Pulp documentation | view source | Contained in the Perl-Critic-Pulp distribution. |
Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots - don't end a paragraph with two dots
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.
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.
http://user42.tuxfamily.org/perl-critic-pulp/index.html
Copyright 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/>.
| Perl-Critic-Pulp documentation | view source | Contained in the Perl-Critic-Pulp distribution. |