GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso(3) User Contributed Perl Documentation Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso(3)

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

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

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]

Perl::Critic::Pulp, Perl::Critic

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

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

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/>.

2021-02-27 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.