]> git.vpit.fr Git - perl/modules/Sub-Nary.git/blobdiff - lib/Sub/Nary.pm
Put each POD sentence on its own line
[perl/modules/Sub-Nary.git] / lib / Sub / Nary.pm
index 4b87e45bc779c0fd4a9c9a3e110b2816c95b8a1b..f7962859f778df31997349a718623213d5a06339 100644 (file)
@@ -33,7 +33,8 @@ BEGIN {
 
 =head1 DESCRIPTION
 
-This module uses the L<B> framework to walk into subroutines and try to guess how many scalars are likely to be returned in list context. It's not always possible to give a definitive answer to this question at compile time, so the results are given in terms of "probability of return" (to be understood in a sense described below).
+This module uses the L<B> framework to walk into subroutines and try to guess how many scalars are likely to be returned in list context.
+It's not always possible to give a definitive answer to this question at compile time, so the results are given in terms of "probability of return" (to be understood in a sense described below).
 
 =head1 METHODS
 
@@ -41,21 +42,27 @@ This module uses the L<B> framework to walk into subroutines and try to guess ho
 
     my $sn = Sub::Nary->new;
 
-The usual constructor. Currently takes no argument.
+The usual constructor.
+Currently takes no argument.
 
 =head2 C<nary>
 
     my $res = $sn->nary($coderef);
 
-Takes a reference to a named or anonymous subroutine, and returns a hash reference whose keys are the possible numbers of returning scalars, and the corresponding values the "probability" to get them. The special key C<'list'> is used to denote a possibly infinite number of returned arguments. The return value hence would look at
+Takes a reference to a named or anonymous subroutine, and returns a hash reference whose keys are the possible numbers of returning scalars, and the corresponding values the "probability" to get them.
+The special key C<'list'> is used to denote a possibly infinite number of returned arguments.
+The return value hence would look at
 
     { 1 => 0.2, 2 => 0.4, 4 => 0.3, list => 0.1 }
 
-that is, we should get C<1> scalar C<1> time over C<5> and so on. The sum of all values is C<1>. The returned result, and all the results obtained from intermediate subs, are cached into the object.
+that is, we should get C<1> scalar C<1> time over C<5> and so on.
+The sum of all values is C<1>.
+The returned result, and all the results obtained from intermediate subs, are cached into the object.
 
 =head2 C<flush>
 
-Flushes the L<Sub::Nary> object cache. Returns the object itself.
+Flushes the L<Sub::Nary> object cache.
+Returns the object itself.
 
 =head1 PROBABILITY OF RETURN
 
@@ -113,7 +120,8 @@ never returns C<1> argument but returns C<2> with probability C<1/2 * 1/2 = 1/4>
 
 If a core function may return different numbers of scalars, each kind is considered equally possible.
 
-For example, C<stat> returns C<13> elements on success and C<0> on error. The according probability will then be C<< { 0 => 0.5, 13 => 0.5 } >>.
+For example, C<stat> returns C<13> elements on success and C<0> on error.
+The according probability will then be C<< { 0 => 0.5, 13 => 0.5 } >>.
 
 =item *
 
@@ -614,7 +622,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-nary at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Nary>.  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-nary at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Nary>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT