Perl::Critic::Policy::Documentation::ProhibitParagraphEndComma(3pm)

Perl::Critic::Policy::Documentation::ProhibitParagraphEndComma3pm

Avoid comma at end of section

Overview

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

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

Releases

4 releases since Debian 10 (Buster); the text changed 1 time.

  1. 10
  2. 11–13

From libperl-critic-pulp-perl 99-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.