GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PERL::CRITIC::POLICY::DOCUMENTATION::REQUIREFINALCUT (3)

.ds Aq ’

NAME

Perl::Critic::Policy::Documentation::RequireFinalCut - end POD with =cut directive

CONTENTS

DESCRIPTION

This policy is part of the Perl::Critic::Pulp add-on. It asks you to end POD with a =cut directive at the end of a file.



    =head1 DOCO

    Some text.

    =cut             # ok



The idea is to have a definite end indication for human readers. Perl and the POD processors don’t require a final =cut. On that basis this policy is lowest priority and under the cosmetic theme (see POLICY THEMES in Perl::Critic).

If there’s no POD in the file then a =cut is not required. Or if the POD is not at the end of file then final =cut at the end is not required.



    =head2 About foo

    =cut

    sub foo {
    }              # ok, file ends with code not POD



If there’s POD at end of file but consists only of =begin/=end blocks then a =cut is not required. It’s reckoned the =end is enough in this case.



    =begin wikidoc

    Entire document in wiki style.

    =end wikidoc          # ok, =cut not required



If you’ve got a mixture of POD and =begin blocks then a =cut is still required. The special allowance is when the only text an =begin block, presumably destined for some other markup system.

    Disabling

If you don’t care about a final =cut you can disable RequireFinalCut from your .perlcriticrc in the usual way (see CONFIGURATION in Perl::Critic),



    [-Documentation::RequireFinalCut]



SEE ALSO

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

Perl::Critic::Policy::Documentation::RequireEndBeforeLastPod, Perl::Critic::Policy::Documentation::RequirePodAtEnd

HOME PAGE

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

COPYRIGHT

Copyright 2012, 2013, 2014, 2015 Kevin Ryde

Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PERL::CRITIC::POLICY::DOCUMENTATION::REQUIREFINALCUT (3) 2015-01-04

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.