.\" 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::ProhibitLinkToSelf 3pm" .TH Perl::Critic::Policy::Documentation::ProhibitLinkToSelf 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::ProhibitLinkToSelf \- don't L<> link to own POD .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It asks you not to use \f(CW\*(C`L<>\*(C'\fR markup to refer to a \s-1POD\s0 document itself. .PP .Vb 1 \& =head1 NAME \& \& My::Package \- something \& \& =head1 DESCRIPTION \& \& L does blah blah ... # bad \& \& =head1 SEE ALSO \& \& L # bad .Ve .PP The idea is that it doesn't make sense to link to a document from within itself. If rendered as a clickable link then it may suggest there's somewhere else to go to read about the module when in fact you're already looking at it. .PP This is only a minor thing though, so this policy is low severity and under the \f(CW\*(C`cosmetic\*(C'\fR theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .PP In ordinary text the suggestion is plain \f(CW\*(C`C<>\*(C'\fR or similar for one's own module name, .PP .Vb 1 \& C does something something ... # ok .Ve .PP In a \*(L"\s-1SEE ALSO\*(R"\s0 a link to self in very likely a typo, or too much cut and paste, or at least pretty unnecessary since there's no need to \*(L"see also\*(R" what you've just read. .PP If linking to a particular section within one's own document then use \&\f(CW\*(C`L<>\*(C'\fR with just the section part. This will probably give better looking output from the formatters too, .PP .Vb 1 \& L # bad \& \& L # ok .Ve .PP For this policy the name of the \s-1POD\s0 is picked out of the \*(L"=head1 \s-1NAME\*(R"\s0 section, so doesn't depend on the filename or directory where \f(CW\*(C`perlcritic\*(C'\fR is run. In the current code multiple names can be given in man-page style. Not sure if that's a good idea. .PP .Vb 1 \& =head1 NAME \& \& My::Package \-\- blah \& \& My::Package::Parser \-\- and its parser \& \& =head1 DESCRIPTION .Ve .PP It's always possible an \f(CW\*(C`L<>\*(C'\fR is right and in fact the \*(L"\s-1NAME\*(R"\s0 appearing is wrong. A violation on the \f(CW\*(C`L<>\*(C'\fR will at least show there's something fishy in the one or the other. .SS "Disabling" .IX Subsection "Disabling" If you don't care about this then you can always disable \&\f(CW\*(C`ProhibitLinkToSelf\*(C'\fR from your \fI.perlcriticrc\fR file in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Documentation::ProhibitLinkToSelf] .Ve .PP If you like to almost always put \f(CW\*(C`L<>\*(C'\fR on module names, including in the module's own \s-1POD,\s0 then disable this policy. Maybe an option in the future could allow links to self in ordinary text but prohibit in \*(L"\s-1SEE ALSO\*(R".\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic .PP Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName, Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks .SH "HOME PAGE" .IX Header "HOME PAGE" .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 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 .