The Perl Advent Calendar needs more articles for 2022. Submit your idea today!

Search results for "module:Perl::Critic::Policy::Documentation::RequirePodSections"

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.140 - 24 Mar 2021 03:09:35 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.140 - 24 Mar 2021 03:09:35 UTC

Perl::Critic::Policy::Documentation::ProhibitDuplicateHeadings - don't duplicate =head names 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 duplicate heading names in "=head" POD commands. =head1 SOMETHING =head1 SOMETHING # bad, duplicate Duplication is usually a mistake, perhaps too much cut-and-paste, or a left...

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
4 results (0.082 seconds)