logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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 is allowed to end with a comma when before an "=over" or a verbatim block, 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]

Home Page

Name

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

See Also

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

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

See Also