Perl::CriticPerl::Critic::Policy::Documentation::RequirePodLinksIncludeText(3)NAMEPerl::Critic::Policy::Documentation::RequirePodLinksIncludeText-
Provide text to display with your pod links.
AFFILIATION
This Policy is part of the core Perl::Critic distribution.
DESCRIPTION
This Policy requires your POD links to contain text to override your
POD translator's default link text, where this is possible. Failure to
provide your own text leaves you at the mercy of the POD translator,
which may display something like "L<Foo>" as "the Foo manpage".
By default, links that specify a documentation section (for example,
"L<Foo/bar>", or "L</bar>") are exempt from this Policy.
CONFIGURATION
This Policy has two boolean options to configure the handling of links
that specify a documentation section.
The "allow_external_sections" option configures the handling of links
of the form "L<Foo/bar>". If true, such links are accepted even
without a text specification. Such links tend to be turned into
something like "bar in Foo".
By default, this option is asserted. If you want to prohibit things
like "L<Foo/bar>" (while allowing things like "L<< Foo->bar()|Foo/bar
>>"), put something like this in your .perlcriticrc:
[Documentation::RequirePodLinksIncludeText]
allow_external_sections = 0
The "allow_internal_sections" option configures the handling of links
of the form "L</bar>". If true, such links are accepted even without a
text specification. Such links tend to be turned into something like
"bar".
By default, this option is asserted. If you want to prohibit things
like "L</bar>" (while allowing things like "L<bar()|/bar>"), put
something like this in your .perlcriticrc:
[Documentation::RequirePodLinksIncludeText]
allow_internal_sections = 0
AUTHOR
Thomas R. Wyant, III wyant at cpan dot org
COPYRIGHT
Copyright (c) 2009-2011 Thomas R. Wyant, III.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. The full text of this license can
be found in the LICENSE file included with this module
perl v5.14.1Perl::Critic::Policy::Documentation::RequirePodLinksIncludeText(3)
