Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Perl::Critic::Perl::CrUser:ContributedcPerltDocumentationitParagraphTwoDots(3)

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

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

	   Some	thing..			   # bad

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

       Three or	more dots as an	ellipsis is fine,

	   And some more of this ...	   # ok

       and anything within a paragraph is fine,

	   Numbers 1 ..	10 are handled.	   # ok

       Only text paragraphs are	checked.  Verbatim paragraphs can end with
       anything	at all

	   This	is an example,

	       example_code (1 ..	   # ok

       There might be other dubious paragraph endings this policy could	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 new enough "Perl::Critic", but if
       you have	an "__END__" token then	any "no	critic"	generally must be
       before that.

SEE ALSO
       Perl::Critic::Pulp, Perl::Critic

       Perl::Critic::Policy::Documentation::ProhibitParagraphEndComma

HOME PAGE
       <http://user42.tuxfamily.org/perl-critic-pulp/index.html>

COPYRIGHT
       Copyright 2011, 2012, 2013, 2014, 2015, 2016, 2017 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 v5.24.1  Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots(3)

NAME | DESCRIPTION | SEE ALSO | HOME PAGE | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Perl::Critic::Policy::Documentation::ProhibitParagraphTwoDots&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help