Add test for modify-in-place usage of ->map, as well as an example in the pod docs.

[gitmo/Moose-Autobox.git] / lib / Moose / Autobox / Array.pm

diff --git a/lib/Moose/Autobox/Array.pm b/lib/Moose/Autobox/Array.pm
index 848fbfd..6234435 100644 (file)
--- a/lib/Moose/Autobox/Array.pm
+++ b/lib/Moose/Autobox/Array.pm
@@ -232,6 +232,24 @@ This is a role to describe operations on the Array type.
 
 =item B<grep (\&block)>
 
+Note that, in both the above, $_ is in scope within the code block, as well as 
+being passed as $_[0]. As per CORE::map and CORE::grep, $_ is an alias to 
+the list value, so can be used to to modify the list, viz:
+
+    use Moose::Autobox;
+
+    my $foo = [1, 2, 3]; 
+    $foo->map( sub {$_++} ); 
+    print $foo->dump;
+
+yields
+
+   $VAR1 = [
+             2,
+             3,
+             4
+           ];
+        
 =item B<reverse>
 
 =item B<sort (?\&block)>