[Catalyst-commits] r11350 - Catalyst-Runtime/5.80/trunk/lib

[hobbs at dev.catalyst.perl.org]

Author: hobbs
Date: 2009-09-10 07:20:31 +0000 (Thu, 10 Sep 2009)
New Revision: 11350

Modified:
   Catalyst-Runtime/5.80/trunk/lib/Catalyst.pm
Log:
Rework the C<< $c->go >> documentation a little, hopefully it's more clear.


Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst.pm	2009-09-10 02:13:04 UTC (rev 11349)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst.pm	2009-09-10 07:20:31 UTC (rev 11350)
@@ -403,13 +403,16 @@
 
 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
 
-Almost the same as L<< detach|/"$c->detach( $action [, \@arguments ] )" >>, but does a full dispatch like L</visit>,
-instead of just calling the new C<$action> /
-C<< $class->$method >>. This means that C<begin>, C<auto> and the
-method you visit are called, just like a new request.
+The relationship between C<go> and 
+L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
+the relationship between 
+L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
+L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
+C<< $c->go >> will perform a full dispatch on the specified action or method,
+with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
+C<go> escapes the processing of the current request chain on completion, and
+does not return to its caller.
 
-C<< $c->stash >> is kept unchanged.
-
 =cut
 
 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }