.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic 3pm"
.TH Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic \- Remove ineffective "## no critic" annotations.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Sometimes, you may need to use a \f(CW"## no critic"\fR annotation to work around
a false-positive bug in Perl::Critic.  But eventually, that bug might get
fixed, leaving your code with extra \f(CW"## no critic"\fR annotations lying about.
Or you may use them to locally disable a Policy, but then later decide to
permanently remove that Policy entirely from your profile, making some of
those \f(CW"## no critic"\fR annotations pointless.  Or, you may accidentally
disable too many Policies at once, creating an opportunity for new
violations to slip in unnoticed.
.PP
This Policy will emit violations if you have a \f(CW"## no critic"\fR annotation in
your source code that does not actually suppress any violations given your
current profile.  To resolve this, you should either remove the annotation
entirely, or adjust the Policy name patterns in the annotation to match only
the Policies that are actually being violated in your code.
.SH EXAMPLE
.IX Header "EXAMPLE"
For example, let's say I have a regex, but I don't want to use the \f(CW\*(C`/x\*(C'\fR flag,
which violates the \f(CW\*(C`RegularExpressions::RequireExtendedFormatting\*(C'\fR policy.
In the following code, the \f(CW"## no critic"\fR annotation will suppress
violations of that Policy and ALL Policies that match
\&\f(CW\*(C`m/RegularExpressions/imx\*(C'\fR
.PP
.Vb 1
\&  my $re = qr/foo bar baz/ms;  ## no critic (RegularExpressions)
.Ve
.PP
However, this creates a potential loop-hole for someone to introduce
additional violations in the future, without explicitly acknowledging them.
This Policy is designed to catch these situations by warning you that you've
disabled more Policies than the situation really requires.  The above code
should be remedied like this:
.PP
.Vb 1
\&  my $re = qr/foo bar baz/ms;  ## no critic (RequireExtendedFormatting)
.Ve
.PP
Notice how the \f(CW\*(C`RequireExtendedFormatting\*(C'\fR pattern more precisely matches
the name of the Policy that I'm trying to suppress.
.SH NOTE
.IX Header "NOTE"
Changing your \fI.perlcriticrc\fR file and disabling policies globally or running
at a higher (i.e. less restrictive) severity level may cause this Policy to
emit additional violations.  So you might want to defer using this Policy
until you have a fairly stable profile.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH ACKNOWLEDGMENT
.IX Header "ACKNOWLEDGMENT"
This Policy was inspired by Adam Kennedy's article at
<http://use.perl.org/article.pl?sid=08/09/24/1957256>.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2021 Imaginative Software Systems.  All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module.