.\" 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::RequireEndBeforeLastPod 3pm" .TH Perl::Critic::Policy::Documentation::RequireEndBeforeLastPod 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::RequireEndBeforeLastPod \- require _\|_END_\|_ before POD at end of file .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It requires that you put an \f(CW\*(C`_\|_END_\|_\*(C'\fR before \s-1POD\s0 which is at the end of a file. For example, .PP .Vb 3 \& program_code(); \& 1; \& _\|_END_\|_ # good \& \& =head1 NAME \& ... .Ve .PP and not merely .PP .Vb 2 \& program_code(); \& 1; # bad \& \& =head1 NAME \& ... .Ve .PP This is primarily a matter of personal preference, so the policy is low severity and only under the \*(L"cosmetic\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). An \f(CW\*(C`_\|_END_\|_\*(C'\fR like this has no effect on execution, but it's a fairly common convention since it's a good human indication you mean the code to end there, and it stops Perl parsing through the \s-1POD\s0 which may save a few nanoseconds. .PP This policy is looser than \f(CW\*(C`Documentation::RequirePodAtEnd\*(C'\fR. This policy allows \s-1POD\s0 to be anywhere in among the code, the requirement is only that if the file ends with \s-1POD\s0 then you should have an \f(CW\*(C`_\|_END_\|_\*(C'\fR between the last code and last \s-1POD.\s0 .PP A file of all \s-1POD,\s0 or all code, or which ends with code, is ok. Ending with code is usual if you write your \s-1POD\s0 at the start of the file or in among the functions etc, .PP .Vb 1 \& =pod \& \& And that\*(Aqs all. \& \& =cut \& \& cleanup (); \& exit 0; # good .Ve .PP A file using \f(CW\*(C`_\|_DATA_\|_\*(C'\fR is always ok, since you can't have \f(CW\*(C`_\|_END_\|_\*(C'\fR followed by \f(CW\*(C`_\|_DATA_\|_\*(C'\fR, wherever you want your \s-1POD.\s0 If the \f(CW\*(C`_\|_DATA_\|_\*(C'\fR is in fact \f(CW\*(C`SelfLoader\*(C'\fR code then it can helpfully have an \f(CW\*(C`_\|_END_\|_\*(C'\fR within it, but as of \f(CW\*(C`perlcritic\*(C'\fR version 1.092 no checks at all are applied to SelfLoader sections. .SS "Disabling" .IX Subsection "Disabling" As always if you don't care about \f(CW\*(C`_\|_END_\|_\*(C'\fR you can disable \&\f(CW\*(C`RequireEndBeforeLastPod\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Documentation::RequireEndBeforeLastPod] .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Documentation::RequirePodAtEnd .SH "HOME PAGE" .IX Header "HOME PAGE" .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2008, 2009, 2010, 2011, 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 .