Browse files

swapping head2 for head3 when it comes to functions/methods as was su…

…ggested in #208
  • Loading branch information...
1 parent b983942 commit 1f0171404f3188caa4f6d404fcf1d184929512db ben hengst committed Feb 27, 2013
Showing with 26 additions and 26 deletions.
  1. +5 −5 lib/
  2. +15 −15 lib/perl5i/Meta.pod
  3. +6 −6 lib/perl5i/Signature.pod
@@ -853,19 +853,19 @@ signature. See L<perl5i::Signature> for details. Otherwise it
returns nothing.
-=head2 caller
+=head3 caller
L<Perl6::Caller> causes C<caller> to return an object in scalar
-=head2 die
+=head3 die
C<die> now always returns an exit code of 255 instead of trying to use
C<$!> or C<$?> which makes the exit code unpredictable. If you want
to exit with a message and a special exit code, use C<warn> then
-=head2 list
+=head3 list
C<list> will force list context similar to how
L<scalar|perlfunc/scalar> will force scalar context.
@@ -897,7 +897,7 @@ STDOUT, STDIN, STDERR and all newly opened filehandles will have UTF8
encoding turned on. Consequently, if you want to output raw bytes to
a file, such as outputting an image, you must set C<< binmode $fh >>.
-=head2 capture
+=head3 capture
my($stdout, $stderr) = capture { ... } %options;
my $stdout = capture { ... } %options;
@@ -1073,7 +1073,7 @@ mistakenly try to turn a function call into an indirect method call.
See L<indirect> for details.
-=head2 want()
+=head3 want
C<want()> generalizes the mechanism of the wantarray function, allowing a
function to determine the context it's being called in. Want distinguishes
@@ -63,7 +63,7 @@ name.
=head1 METHODS
-=head2 id
+=head3 id
my $id = $object->mo->id;
@@ -75,14 +75,14 @@ The identifier is guaranteed to be:
* a true value
* independent of changes to the object's contents
-=head2 class
+=head3 class
my $class = $object->mo->class;
my $class = $class->mc->class;
Returns the class of the $object or $class.
-=head2 ISA
+=head3 ISA
my @ISA = $object->mo->ISA;
my @ISA = $class->mc->ISA;
@@ -95,7 +95,7 @@ Essentially equivalent to:
my @ISA = @{$class.'::ISA'};
-=head2 linear_isa
+=head3 linear_isa
my @isa = $class->mc->linear_isa();
my @isa = $object->mo->linear_isa();
@@ -112,7 +112,7 @@ This list includes the $class itself and includes UNIVERSAL. For example:
my @isa = Child->mo->linear_isa();
-=head2 methods
+=head3 methods
my @methods = $class->mc->methods;
my $methods = $class->mc->methods;
@@ -136,7 +136,7 @@ C<just_mine>, if true, returns only methods defined in the $class.
It defaults to false.
-=head2 symbol_table
+=head3 symbol_table
my $table = $class->mc->symbol_table;
my $table = $obj->mo->symbol_table;
@@ -147,7 +147,7 @@ If you don't know what a symbol table is... good. If you really want to
know, see L<perldata/Typeglobs and FileHandles>.
-=head2 super
+=head3 super
my @return = $class->mc->super(@args);
my @return = $object->mo->super(@args);
@@ -159,7 +159,7 @@ class of the $object rather than the class in which the current method
was declared.
-=head2 is_tainted
+=head3 is_tainted
my $is_tainted = $object->mo->is_tainted;
@@ -171,7 +171,7 @@ String and numerically overloaded objects will check against their
overloaded versions.
-=head2 taint
+=head3 taint
@@ -187,7 +187,7 @@ themselves. Generally this is applicable to string or numeric
overloaded objects who can taint their overloaded value.
-=head2 untaint
+=head3 untaint
@@ -203,13 +203,13 @@ themselves. Generally this is applicable to string or numeric
overloaded objects who can untaint their overloaded value.
-=head2 reftype
+=head3 reftype
my $reftype = $object->mo->reftype;
Returns the underlying reference type of the $object.
-=head2 checksum
+=head3 checksum
my $checksum = $object->mo->checksum;
my $md5 = $object->mo->checksum( algorithm => 'md5' );
@@ -245,7 +245,7 @@ Defaults to hex.
-=head2 is_equal
+=head3 is_equal
@@ -264,13 +264,13 @@ Examples:
my $uri = URI->new("");
$uri->mo->is_equal("") # True
-=head2 perl
+=head3 perl
my $dump = $object->mo->perl;
Dumps the contents of the $object as Perl in a string, like Data::Dumper.
-=head2 dump
+=head3 dump
my $dump = $object->mo->dump( format => $format );
@@ -27,23 +27,23 @@ signature.
=head1 METHODS
-=head2 params
+=head3 params
my $params = $sig->params;
An array ref of the parameters a subroutine takes in the order it
takes them. Currently they are just strings. In the future they will
be string overloaded objects.
-=head2 positional_params
+=head3 positional_params
my $params = $sig->positional_params;
Like C<< $sig->params >> but it is just the positional parameters.
In the future there will be named parameters.
-=head2 num_positional_params
+=head3 num_positional_params
my $num_positional_params = $sig->num_positional_params;
@@ -55,21 +55,21 @@ look just at the positional ones.
This is mostly an optimization for C<< $sig->positional_params->size >>.
-=head2 as_string
+=head3 as_string
my $params = $sig->as_string;
The original signature string.
-=head2 invocant
+=head3 invocant
my $invocant = $sig->invocant;
The invocant is the object or class a method is called on.
C<invocant> will return the parameter which contains this, by default
it is C<$self> on a method, and nothing a regular subroutine.
-=head2 is_method
+=head3 is_method
my $is_method = $sig->is_method;

0 comments on commit 1f01714

Please sign in to comment.