Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso(3)

NAME
Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso - don't duplicate L<> links in SEE ALSO

DESCRIPTION
This policy is part of the "Perl::Critic::Pulp" add-on. It asks you not to duplicate "L<Foo>" links in a SEE ALSO section.

    =head1 SEE ALSO

    L<Foo::Bar>

    L<Foo::Bar>    # bad

The idea is that for readability a given cross-reference should be linked just once and a duplicate is likely a leftover from too much cut-and-paste etc. This is minor matter so this policy is low severity and under the "cosmetic" theme (see "POLICY THEMES" in Perl::Critic).

A module can appear more than once in a SEE ALSO, but only "L<>" linked once. Anything else should be "C<>" markup or plain text.

    L<Foo::One>, L<Foo::Two>
    (C<Foo::Two> runs faster)     # ok

Links to different parts of a target POD are allowed,

    L<perlfunc/alarm>,
    L<perlfunc/kill>     # ok

  Disabling
If you don't care about this then you can always disable "ProhibitDuplicateSeeAlso" from your .perlcriticrc file in the usual way (see "CONFIGURATION" in Perl::Critic),

    [-Documentation::ProhibitDuplicateSeeAlso]

SEE ALSO
Perl::Critic::Pulp, Perl::Critic

Perl::Critic::Policy::Documentation::ProhibitAdjacentLinks, Perl::Critic::Policy::Documentation::ProhibitLinkToSelf

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

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