/ 
Perl-Critic-Pulp-97
River stage two • 5 direct dependents • 18 total dependents
/ Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks

NAME

Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks - consecutive L<> links

DESCRIPTION

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
L<Bar>

The idea is adjacent L<> like this is probably a missing comma or missing text. It's easy to make this mistake in a "SEE ALSO" list.

This is normally only very minor and on that basis this policy is lowest severity and under the "cosmetic" theme (see "POLICY THEMES" in Perl::Critic).

Exceptions

An exception is made for two links to the same page where one (or both) have display text,

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 text too.

Disabling

If you don't care about this sort of thing at all you can disable ProhibitAdjacentLinks from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),

[-Documentation::ProhibitAdjacentLinks]

BUGS

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.

SEE ALSO

Perl::Critic::Pulp, Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso, Perl::Critic::Policy::Documentation::ProhibitLinkToSelf, Perl::Critic::Policy::Documentation::RequirePodLinksIncludeText, Perl::Critic::Policy::Documentation::RequireLinkedURLs

HOME PAGE

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

COPYRIGHT

Copyright 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 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/>.