Search results for "module:Perl::Critic::Annotation"

Perl::Critic::Annotation - A "## no critic" annotation in a document. River stage three • 131 direct dependents • 386 total dependents

"Perl::Critic::Annotation" represents a single "## no critic" annotation in a PPI::Document. The Annotation takes care of parsing the annotation and keeps track of which lines and Policies it affects. It is intended to encapsulate the details of the ...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic - Critique Perl source code for best-practices. River stage three • 131 direct dependents • 386 total dependents

Perl::Critic is an extensible framework for creating and applying coding standards to Perl source code. Essentially, it is a static source code analysis engine. Perl::Critic is distributed with a number of Perl::Critic::Policy modules that attempt to...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic::Document - Caching wrapper around a PPI::Document. River stage three • 131 direct dependents • 386 total dependents

Perl::Critic does a lot of iterations over the PPI document tree via the "PPI::Document::find()" method. To save some time, this class pre-caches a lot of the common "find()" calls in a single traversal. Then, on subsequent requests we return the cac...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic::Policy::Documentation::RequirePodSections - Organize your POD into the customary sections. River stage three • 131 direct dependents • 386 total dependents

This Policy requires your POD to contain certain "=head1" sections. If the file doesn't contain any POD at all, then this Policy does not apply. Tools like Module::Starter make it really easy to ensure that every module has the same documentation fra...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic::Policy::Modules::RequireBarewordIncludes - Write require Module instead of require 'Module.pm'. River stage three • 131 direct dependents • 386 total dependents

When including another module (or library) via the "require" or "use" statements, it is best to identify the module (or library) using a bareword rather than an explicit path. This is because paths are usually not portable from one machine to another...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic::Policy::Documentation::ProhibitUnbalancedParens - don't leave an open bracket or paren River stage two • 5 direct dependents • 18 total dependents

This policy is part of the "Perl::Critic::Pulp" add-on. It reports unbalanced or mismatched parentheses, brackets and braces in POD text paragraphs, Blah blah (and something. # bad Blah blah ( [ ). # bad Blah blah brace }. # bad This is only cosmetic...

KRYDE/Perl-Critic-Pulp-99 - 28 Feb 2021 08:34:14 UTC

Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup - unexpanded Cltgt etc markup in POD verbatim paras River stage two • 5 direct dependents • 18 total dependents

This policy is part of the "Perl::Critic::Pulp" add-on. It reports POD verbatim paragraphs which contain markup like B<> or C<>. That markup will appear literally in the formatted output where you may have meant fontification. =head1 SOME THING Parag...

KRYDE/Perl-Critic-Pulp-99 - 28 Feb 2021 08:34:14 UTC

Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup - don't use Cltgt markup in a NAME section River stage two • 5 direct dependents • 18 total dependents

This policy is part of the "Perl::Critic::Pulp" add-on. It asks you not to write C<> markup in the NAME section of the POD because it comes out badly in the man-db "apropos" database. For example, =head1 NAME foo - like the C<bar> program # bad "pod2...

KRYDE/Perl-Critic-Pulp-99 - 28 Feb 2021 08:34:14 UTC

Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic - Remove ineffective "## no critic" annotations. River stage three • 131 direct dependents • 386 total dependents

Sometimes, you may need to use a "## no critic" annotation to work around a false-positive bug in Perl::Critic. But eventually, that bug might get fixed, leaving your code with extra "## no critic" annotations lying about. Or you may use them to loca...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC

Perl::Critic::Policy::Miscellanea::ProhibitUnrestrictedNoCritic - Forbid a bare ## no critic River stage three • 131 direct dependents • 386 total dependents

A bare "## no critic" annotation will disable all the active Policies. This creates holes for other, unintended violations to appear in your code. It is better to disable only the particular Policies that you need to get around. By putting Policy nam...

PETDANCE/Perl-Critic-1.142 - 29 Nov 2022 02:20:23 UTC
10 results (0.052 seconds)