[Catalyst-commits] r12688 - Catalyst-Runtime/5.80/branches/action_args/lib/Catalyst

[rafl at dev.catalyst.perl.org]

Author: rafl
Date: 2010-01-19 16:00:15 +0000 (Tue, 19 Jan 2010)
New Revision: 12688

Modified:
   Catalyst-Runtime/5.80/branches/action_args/lib/Catalyst/Controller.pm
Log:
Some more doc tweaking.

Modified: Catalyst-Runtime/5.80/branches/action_args/lib/Catalyst/Controller.pm
===================================================================
--- Catalyst-Runtime/5.80/branches/action_args/lib/Catalyst/Controller.pm	2010-01-19 15:52:49 UTC (rev 12687)
+++ Catalyst-Runtime/5.80/branches/action_args/lib/Catalyst/Controller.pm	2010-01-19 16:00:15 UTC (rev 12688)
@@ -448,21 +448,24 @@
 
 =head2 action_args
 
-Allows you to set constructor arguments on your Actions or ActionRoles.  You can
-set args globally (all actions of the controller) and specifically (for a single
-action).
+Allows you to set constructor arguments on your Actions. You can set arguments
+globally (for all actions of the controller) and specifically (for a single
+action). This is particularly useful when using C<ActionRole>s
+(L<Catalyst::Controller::ActionRole>) and custom C<ActionClass>es.
 
-    __PACKAGE__->config({
+    __PACKAGE__->config(
         action_args => {
-            '*' => {globalarg1=>'hello', globalarg2=>'goodbye'},
-            'specific_action' => {customarg=>'arg1'},
+            '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
+            'specific_action' => { customarg => 'arg1' },
         },
-     });
+     );
 
-In the case above the action class associated with 'specific_action' would get
-passed the following arguments when it is instantiated: (globalarg1=>'hello',
-globalarg2=>'goodbye', 'customarg=>'arg1').
+In the case above the action class associated with C<specific_action> would get
+passed the following arguments, in addition to the normal action constructor
+arguments, when it is instantiated:
 
+  (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
+
 =head1 METHODS
 
 =head2 BUILDARGS ($app, @args)