Fix plugin links in POD

[catagits/Catalyst-View-Component-SubInclude.git] / lib / Catalyst / View / Component / SubInclude / Visit.pm

diff --git a/lib/Catalyst/View/Component/SubInclude/Visit.pm b/lib/Catalyst/View/Component/SubInclude/Visit.pm
index 6bd96a5..88e883c 100644 (file)
--- a/lib/Catalyst/View/Component/SubInclude/Visit.pm
+++ b/lib/Catalyst/View/Component/SubInclude/Visit.pm
@@ -40,10 +40,6 @@ render subinclude contents.
 
 This method is only supported when using L<Catalyst> version 5.71000 or newer.
 
-B<WARNING: As of Catalyst version 5.71000, this plugin doesn't work for chained 
-actions with captured arguments>. Apparently, C<visit> doesn't handle this type 
-of actions yet.
-
 =head1 METHODS
 
 =head2 C<generate_subinclude( $c, $path, @args )>
@@ -56,6 +52,25 @@ But it will handle all the nasty details such as localizing the stash,
 parameters and response body. This is necessary to keep behavior consistent 
 with the other plugins.
 
+=head1 CONFIGURATION
+
+=head2 keep_stash
+
+You can choose to not localize the stash for Visits' subinclude calls. The subrequest
+will have the same stash as the request that spawned it. Configure the keep_stash key
+in your view:
+
+    __PACKAGE__->config(
+        subinclude => {
+            'Visit' => {
+                keep_stash => 1,
+            },
+        }
+    );
+
+Note: changes in the stash during a Visit subinclude will be visible after the include 
+returns.
+
 =cut
 
 has keep_stash => (