Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks(3pm)

Overview

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]

Home page

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

Releases

4 releases since Debian 10 (Buster); the text changed 1 time.

10
11–13