.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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::Documentation::RequireFinalCut 3pm" .TH Perl::Critic::Policy::Documentation::RequireFinalCut 3pm "2021-02-28" "perl v5.32.1" "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::Documentation::RequireFinalCut \- end POD with =cut directive .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It asks you to end \s-1POD\s0 with a \f(CW\*(C`=cut\*(C'\fR directive at the end of a file. .PP .Vb 1 \& =head1 DOCO \& \& Some text. \& \& =cut # ok .Ve .PP The idea is to have a definite end indication for human readers. Perl and the \s-1POD\s0 processors don't require a final \f(CW\*(C`=cut\*(C'\fR. On that basis this policy is lowest severity and under the \*(L"cosmetic\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .PP If there's no \s-1POD\s0 in the file then a \f(CW\*(C`=cut\*(C'\fR is not required. Or if the file ends with code rather than \s-1POD\s0 then a \f(CW\*(C`=cut\*(C'\fR after that code is not required. .PP .Vb 1 \& =head2 About foo \& \& =cut \& \& sub foo { \& } # ok, file ends with code not POD .Ve .PP If there's \s-1POD\s0 at end of file but consists only of \f(CW\*(C`=begin/=end\*(C'\fR blocks then a \f(CW\*(C`=cut\*(C'\fR is not required. It's reckoned the \f(CW\*(C`=end\*(C'\fR is enough in this case. .PP .Vb 1 \& =begin wikidoc \& \& Entire document in wiki style. \& \& =end wikidoc # ok, =cut not required .Ve .PP If the file ends with a mixture of ordinary \s-1POD\s0 and \f(CW\*(C`=begin\*(C'\fR blocks then a is still required. The special allowance is when only \f(CW\*(C`=begin\*(C'\fR blocks, presumably destined for some other markup system. .SS "Blank Line" .IX Subsection "Blank Line" Generally a \f(CW\*(C`=cut\*(C'\fR should have a blank line before it, the same as other \&\s-1POD\s0 commands. But Perl execution doesn't enforce that and the same looseness is permitted here, .PP .Vb 1 \& =pod \& \& Blah blah blah \& =cut # ok without preceding newline .Ve .PP A check for blanks around \s-1POD\s0 commands is left to other policies. The \&\f(CW\*(C`podchecker\*(C'\fR program reports this (Pod::Checker). .SS "Disabling" .IX Subsection "Disabling" If you don't care about a final \f(CW\*(C`=cut\*(C'\fR you can disable \f(CW\*(C`RequireFinalCut\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Documentation::RequireFinalCut] .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic .PP Perl::Critic::Policy::Documentation::RequireEndBeforeLastPod, Perl::Critic::Policy::Documentation::RequirePodAtEnd .SH "HOME PAGE" .IX Header "HOME PAGE" .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde .PP Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Perl-Critic-Pulp is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Perl-Critic-Pulp. If not, see .