Manual Reference Pages - PERL::CRITIC::POLICY::DOCUMENTATION::PROHIBITADJACENTLINKS (3)
Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks - consecutive L<> links
This policy is part of the Perl::Critic::Pulp
add-on. It asks you not to have two adjacent L<> sequences in a
paragraph. For example,
=head1 SEE ALSO
L<Foo> # bad
The idea is adjacent L<> like this is probably a missing comma or
missing text. Its easy to make this mistake in a SEE ALSO list.
This is normally only very minor and on that basis this policy is under the
cosmetic theme (see POLICY THEMES in Perl::Critic) and lowest severity.
An exception is made for two links to the same page where one (or both) have
See L<My::Package> L<new()|My::Package/Contructors> for more.
This hyperlinks both the package name and a function etc within it. Perhaps
exactly when to allow or disallow this might be loosened or tightened in the
future. Adjacent linking is fairly unusual though, and too much linking is
often not a good thing since the meaning ought to be made clear in plain
If you dont care about this sort of thing at all you can disable
ProhibitAdjacentLinks from your .perlcriticrc in the usual way
(see CONFIGURATION in Perl::Critic),
The column position of the offending adjacency is not included in the
violation reported. You may need to look carefully at the line to see the
problem, and at the following line if the adjacent link is on the next line.
Copyright 2010, 2011, 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
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
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/>.
|perl v5.20.3 ||PERL::CRITIC::POLICY::DOCUMENTATION::PROHIBITADJACENTLINKS (3) ||2015-01-04 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.