logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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]

Home Page

Name

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

See Also

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

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

See Also