From: Lukas Mai Date: Sun, 4 Nov 2012 02:01:40 +0000 (+0100) Subject: un-C< > level 2 headings X-Git-Tag: v1.00_02~10 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=0d87c016a41b5c79531b89496bd20f408a44c840;p=p5sagit%2FFunction-Parameters.git un-C< > level 2 headings --- diff --git a/lib/Function/Parameters/Info.pm b/lib/Function/Parameters/Info.pm index 8604eeb..5177d4d 100644 --- a/lib/Function/Parameters/Info.pm +++ b/lib/Function/Parameters/Info.pm @@ -75,33 +75,33 @@ L|Function::Parameters/Introspection> returns objects of this class to describe parameter lists of functions. The following methods are available: -=head2 C<< $info->invocant >> +=head2 $info->invocant Returns the name of the variable into which the first argument is L|perlfunc/shift>ed into automatically, or C if no such thing exists. This will usually return C<'$self'> for methods. -=head2 C<< $info->positional_required >> +=head2 $info->positional_required Returns a list of the names of the required positional parameters (or a count in scalar context). -=head2 C<< $info->positional_optional >> +=head2 $info->positional_optional Returns a list of the names of the optional positional parameters (or a count in scalar context). -=head2 C<< $info->named_required >> +=head2 $info->named_required Returns a list of the names of the required named parameters (or a count in scalar context). -=head2 C<< $info->named_optional >> +=head2 $info->named_optional Returns a list of the names of the optional named parameters (or a count in scalar context). -=head2 C<< $info->slurpy >> +=head2 $info->slurpy Returns the name of the final array or hash that gobbles up all remaining arguments, or C if no such thing exists. @@ -110,14 +110,14 @@ As a special case, functions defined without an explicit parameter list (i.e. without C<( )>) will return C<'@_'> here because they accept any number of arguments. -=head2 C<< $info->args_min >> +=head2 $info->args_min Returns the minimum number of arguments this function requires. This is computed as follows: Invocant and required positional parameters count 1 each. Optional parameters don't count. Required named parameters count 2 each (key + value). Slurpy parameters don't count either because they accept empty lists. -=head2 C<< $info->args_max >> +=head2 $info->args_max Returns the maximum number of arguments this function accepts. This is computed as follows: If there is any named or slurpy parameter, the result is C.