[Catalyst-commits] r11796 - Catalyst-Action-RenderView/trunk/lib/Catalyst/Action

[hobbs at dev.catalyst.perl.org]

Author: hobbs
Date: 2009-11-11 00:37:48 +0000 (Wed, 11 Nov 2009)
New Revision: 11796

Modified:
   Catalyst-Action-RenderView/trunk/lib/Catalyst/Action/RenderView.pm
Log:
Improve docs so the users don't have to chase as many pointers.


Modified: Catalyst-Action-RenderView/trunk/lib/Catalyst/Action/RenderView.pm
===================================================================
--- Catalyst-Action-RenderView/trunk/lib/Catalyst/Action/RenderView.pm	2009-11-10 21:49:42 UTC (rev 11795)
+++ Catalyst-Action-RenderView/trunk/lib/Catalyst/Action/RenderView.pm	2009-11-11 00:37:48 UTC (rev 11796)
@@ -71,13 +71,15 @@
 =head1 DESCRIPTION
 
 This action implements a sensible default end action, which will forward
-to the first available view, unless status is set to 3xx, or there is a
-response body. It also allows you to pass C<dump_info=1> to the url in
+to the first available view, unless C<< $c->res->status >> is a 3xx code
+(redirection, not modified, etc.), 204 (no content), or C<< $c->res->body >> has
+already been set. It also allows you to pass C<dump_info=1> to the url in
 order to force a debug screen, while in debug mode.
 
 If you have more than one view, you can specify which one to use with
-the C<default_view> config setting (see L<Catalyst>'s C<$c-E<gt>view($name)>
-method).
+the C<default_view> config setting and the C<current_view> and
+C<current_view_instance> stash keys (see L<Catalyst>'s C<$c-E<gt>view($name)>
+method -- this module simply calls C<< $c->view >> with no argument).
 
 =head1 METHODS
 
@@ -104,14 +106,14 @@
 $c->config->{'Action::RenderView'}->{ignore_classes}.
 For instance:
 
-    $c->config->{'Action::RenderView'}->{ignore_classes}=[]; 
+    $c->config->{'Action::RenderView'}->{ignore_classes} = []; 
     
 To disable the functionality. You can also set 
 config->{'Action::RenderView'}->{scrubber_func} to change what it does with the 
 classes. For instance, this will undef it instead of putting in the 
 class name:
 
-    $c->config->{'Action::RenderView'}->{scrubber_func}=sub { undef $_ }; 
+    $c->config->{'Action::RenderView'}->{scrubber_func} = sub { undef $_ };
 
 =head2 Deprecation notice