From: Yuval Kogman <nothingmuch@woobling.org>
Date: Thu, 29 Dec 2005 19:46:35 +0000 (+0000)
Subject: Document the new $c->flash "feature"
X-Git-Tag: v0.05~1
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=44ab6d1ca2bd681fed68c3255e14a4ef8ac8949e;p=catagits%2FCatalyst-Plugin-Session.git

Document the new $c->flash "feature"
---

diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm
index 080420b..0cc41ce 100644
--- a/lib/Catalyst/Plugin/Session.pm
+++ b/lib/Catalyst/Plugin/Session.pm
@@ -493,7 +493,12 @@ L</CONFIGURATION>). This is used when creating a new session.
 =item flash
 
 This is like Ruby on Rails' flash data structure. Think of it as a stash that
-lasts a single redirect, not only a forward.
+lasts for longer than one request, letting you redirect instead of forward.
+
+The flash data will be cleaned up only on requests on which actually use
+$c->flash (thus allowing multiple redirections), and the policy is to delete
+all the keys which were present at the time the data was loaded just before the
+data is saved.
 
     sub moose : Local {
         my ( $self, $c ) = @_;