Permalink
Browse files

POD improvements

  • Loading branch information...
alranel committed Feb 2, 2011
1 parent 5e9e62d commit 7820dfdf66c584d07963b00694d2926bde26dba6
Showing with 19 additions and 4 deletions.
  1. +3 −0 Changes
  2. +16 −4 lib/MooseX/Collect.pm
View
@@ -1,3 +1,6 @@
- fixed POD glitches
- added a CAVEATS section to the POD
version 0.90 (2011-02-01):
- new
View
@@ -158,6 +158,7 @@ MooseX::Collect - provides method modifier for collecting method calls from role
sub items () { qw/banana/ }
package Foo;
use Moose;
use MooseX::Collect;
@@ -188,6 +189,7 @@ MooseX::Collect - provides method modifier for collecting method calls from role
with qw(B C);
my @items = $Foo->items; # watermelon, apple, orange, banana
@@ -232,6 +234,7 @@ provider methods. The order is relevant. The value I<self> enables searching of
inside the current class too. The default value is I<self, superclass, roles>.
=item I<method_order =E<gt> 'standard' | 'reverse'>
=item I<method_order =E<gt> 'top_down' | 'bottom_up'>
This option lets you reverse the default method resolution order, which is I<standard>
@@ -248,7 +251,7 @@ recursion), does not affect searching in roles because they have no hierarchy.
=item I<context> =E<gt> 'scalar' | 'list'>
This arguments lets you set the Perl context to use when calling the provider methods. By
default it's value is I<list>.
default its value is I<list>.
=item I<collector =E<gt> CODEREF>
@@ -259,22 +262,31 @@ It will receive the results in @_ and it's expected to return a list.
=back
=head1 CAVEATS
Don't use the I<collect> method modifier to collect data from methods that are already
defined as attribute accessors or extended by other method modifiers such as I<around>,
I<override> etc. or by another I<collect> modifier. In such cases, the behaviour of this
module is B<undefined> and B<unsupported>. You should avoid such usage until a proper
policy is defined.
=head1 SEE ALSO
=over 4
=item C<Moose>
=item L<Moose>
=item C<Moose::Role>
=item L<Moose::Role>
=item C<MooseX::ComposedBehavior>
=item L<MooseX::ComposedBehavior>
=back
=head1 BUGS
Please report any bugs to C<bug-moosex-collect@rt.cpan.org>, or through the web
interface at L<https://rt.cpan.org/Public/Bug/Report.html?Queue=MooseX-Collect>.
The author will be happy to read your feedback.
=head1 AUTHOR

0 comments on commit 7820dfd

Please sign in to comment.