From: Vincent Pit <vince@profvince.com>
Date: Thu, 4 Jun 2009 22:19:02 +0000 (+0200)
Subject: POD cleanup
X-Git-Tag: v0.09~7
X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FSub-Prototype-Util.git;a=commitdiff_plain;h=73786f1f0683e45f68b8d0d486c38e447b085fc4

POD cleanup
---

diff --git a/lib/Sub/Prototype/Util.pm b/lib/Sub/Prototype/Util.pm
index 316d079..6544afc 100644
--- a/lib/Sub/Prototype/Util.pm
+++ b/lib/Sub/Prototype/Util.pm
@@ -34,7 +34,8 @@ $VERSION = '0.08';
 
 =head1 DESCRIPTION
 
-Prototypes are evil, but sometimes you just have to bear with them, especially when messing with core functions. This module provides several utilities aimed at facilitating "overloading" of prototyped functions.
+Prototypes are evil, but sometimes you just have to bear with them, especially when messing with core functions.
+This module provides several utilities aimed at facilitating "overloading" of prototyped functions.
 
 They all handle C<5.10>'s C<_> prototype.
 
@@ -65,7 +66,8 @@ sub _clean_msg {
 
 =head2 C<flatten $proto, @args>
 
-Flattens the array C<@args> according to the prototype C<$proto>. When C<@args> is what C<@_> is after calling a subroutine with prototype C<$proto>, C<flatten> returns the list of what C<@_> would have been if there were no prototype.
+Flattens the array C<@args> according to the prototype C<$proto>.
+When C<@args> is what C<@_> is after calling a subroutine with prototype C<$proto>, C<flatten> returns the list of what C<@_> would have been if there were no prototype.
 
 =cut
 
@@ -103,35 +105,45 @@ sub flatten {
 
 =head2 C<wrap $name, %opts>
 
-Generates a wrapper that calls the function C<$name> with a prototyped argument list. That is, the wrapper's arguments should be what C<@_> is when you define a subroutine with the same prototype as C<$name>.
+Generates a wrapper that calls the function C<$name> with a prototyped argument list.
+That is, the wrapper's arguments should be what C<@_> is when you define a subroutine with the same prototype as C<$name>.
 
     my $a = [ 0 .. 2 ];
     my $push = wrap 'CORE::push';
     $push->($a, 3, 4); # returns 3 + 2 = 5 and $a now contains 0 .. 4
 
-You can force the use of a specific prototype. In this case, C<$name> must be a hash reference that holds exactly one key / value pair, the key being the function name and the value the prototpye that should be used to call it.
+You can force the use of a specific prototype.
+In this case, C<$name> must be a hash reference that holds exactly one key / value pair, the key being the function name and the value the prototpye that should be used to call it.
 
     my $push = wrap { 'CORE::push' => '\@$' }; # only pushes 1 arg
 
-Others arguments are seen as key / value pairs that are meant to tune the code generated by L</wrap>. Valid keys are :
+Others arguments are seen as key / value pairs that are meant to tune the code generated by L</wrap>.
+Valid keys are :
 
 =over 4
 
 =item C<< ref => $func >>
 
-Specifies the function used in the generated code to test the reference type of scalars. Defaults to C<'ref'>. You may also want to use C<Scalar::Util::reftype>.
+Specifies the function used in the generated code to test the reference type of scalars.
+Defaults to C<'ref'>.
+You may also want to use C<Scalar::Util::reftype>.
 
 =item C<< wrong_ref => $code >>
 
-The code executed when a reference of incorrect type is encountered. The result of this snippet is also the result of the generated code, hence it defaults to C<'undef'>. It's a good place to C<croak> or C<die> too.
+The code executed when a reference of incorrect type is encountered.
+The result of this snippet is also the result of the generated code, hence it defaults to C<'undef'>.
+It's a good place to C<croak> or C<die> too.
 
 =item C<< sub => $bool >>
 
-Encloses the code into a C<sub { }> block. Default is true.
+Encloses the code into a C<sub { }> block.
+Default is true.
 
 =item C<< compile => $bool >>
 
-Makes L</wrap> compile the code generated and return the resulting code reference. Be careful that in this case C<ref> must be a fully qualified function name. Defaults to true, but turned off when C<sub> is false.
+Makes L</wrap> compile the code generated and return the resulting code reference.
+Be careful that in this case C<ref> must be a fully qualified function name.
+Defaults to true, but turned off when C<sub> is false.
 
 =back
 
@@ -235,7 +247,9 @@ sub wrap {
 
 =head2 C<recall $name, @args>
 
-Calls the function C<$name> with the prototyped argument list C<@args>. That is, C<@args> should be what C<@_> is when you define a subroutine with the same prototype as C<$name>. You can still force the prototype by passing C<< { $name => $proto } >> as the first argument.
+Calls the function C<$name> with the prototyped argument list C<@args>.
+That is, C<@args> should be what C<@_> is when you call a subroutine with C<$name> as prototype.
+You can still force the prototype by passing C<< { $name => $proto } >> as the first argument.
 
     my $a = [ ];
     recall { 'CORE::push' => '\@$' }, $a, 1, 2, 3; # $a just contains 1
@@ -280,7 +294,8 @@ You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-sub-prototype-util at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Prototype-Util>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-sub-prototype-util at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Prototype-Util>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT