[Catalyst-commits] r10926 - Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst

[t0m at dev.catalyst.perl.org]

Author: t0m
Date: 2009-07-18 10:12:51 +0000 (Sat, 18 Jul 2009)
New Revision: 10926

Modified:
   Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Action.pm
   Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Component.pm
Log:
Document the method name I actually added, idiot

Modified: Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Action.pm
===================================================================
--- Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Action.pm	2009-07-18 09:56:17 UTC (rev 10925)
+++ Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Action.pm	2009-07-18 10:12:51 UTC (rev 10926)
@@ -103,8 +103,8 @@
 
 =head2 class
 
-Returns the class name of the component where this action is defined.
-Derived by calling the L<Catalyst::Component/_component_class|_component_class>
+Returns the name of the component where this action is defined.
+Derived by calling the L<Catalyst::Component/_component_name|_component_name>
 method on each component.
 
 =head2 code

Modified: Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Component.pm
===================================================================
--- Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Component.pm	2009-07-18 09:56:17 UTC (rev 10925)
+++ Catalyst-Runtime/5.80/branches/pass_component_names/lib/Catalyst/Component.pm	2009-07-18 10:12:51 UTC (rev 10926)
@@ -172,13 +172,14 @@
       return $class->new($app, $args);
   }
 
-=head2 _component_class
+=head2 _component_name
 
-The class name of the component within an application. This is used to
-pass the component's class name to actions generated (becoming
+The name of the component within an application. This is used to
+pass the component's name to actions generated (becoming
 C<< $action->class >>). This is needed so that the L</COMPONENT> method can
 return an instance of a different class (e.g. a L<Class::MOP> anonymous class),
-and should be used to retrieve a component instead of C<< ref($self) >>.
+(as finding the component name by C<< ref($self) >> will not work correctly in
+such cases).
 
 =head2 $c->config