Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::documentation::requirepodlinksincludetext(3pm) [debian man page]

Perl::Critic::Policy::Documentation::RequirePodLinksInclUsereContributed Perl Perl::Critic::Policy::Documentation::RequirePodLinksIncludeText(3pm)

NAME

       Perl::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.2							    2012-06-07Perl::Critic::Policy::Documentation::RequirePodLinksIncludeText(3pm)

Check Out this Related Man Page

Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEUser3Contributed Perl DocuPerl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval(3pm)

NAME

       Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval - Write "eval { my $foo; bar($foo) }" instead of "eval "my $foo; bar($foo);"".

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       The string form of "eval" is recompiled every time it is executed, whereas the block form is only compiled once.  Also, the string form
       doesn't give compile-time warnings.

	   eval "print $foo";	     # not ok
	   eval {print $foo};	     # ok

CONFIGURATION

       There is an "allow_includes" boolean option for this Policy.  If set, then strings that look like they only include a single "use" or
       "require" statement (with the possible following statement that consists of a single number) are allowed.  With this option set, the
       following are flagged as indicated:

	   eval 'use Foo';	       # ok
	   eval 'require Foo';	       # ok
	   eval "use $thingy;";        # ok
	   eval "require $thingy;";    # ok
	   eval "use $thingy; 1;";     # ok
	   eval "require $thingy; 1;"; # ok

	   eval 'use Foo; blah;';      # still not ok
	   eval 'require Foo; 2; 1;';  # still not ok
	   eval 'use $thingy;';        # still not ok
	   eval 'no Foo';	       # still not ok

       If you don't understand why the number is allowed, see Perl::Critic::Policy::ErrorHandling::RequireCheckingReturnValueOfEval.

       This option inspired by Ricardo SIGNES' Perl::Critic::Policy::Lax::ProhibitStringyEval::ExceptForRequire.

SEE ALSO

       Perl::Critic::Policy::ControlStrucutres::RequireBlockGrep

       Perl::Critic::Policy::ControlStrucutres::RequireBlockMap

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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.2							    2012-06-07	  Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval(3pm)
Man Page