From 8da91036c0f6b4caf10e46db07f04d49398eea28 Mon Sep 17 00:00:00 2001
From: Christine Yen <cyen@christineyen.com>
Date: Wed, 15 Jun 2011 01:55:57 -0700
Subject: Improve documentation around status code argument of redirect_to
---
actionpack/lib/action_controller/metal/redirecting.rb | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
(limited to 'actionpack/lib')
diff --git a/actionpack/lib/action_controller/metal/redirecting.rb b/actionpack/lib/action_controller/metal/redirecting.rb
index 55c650df6c..99e200caa5 100644
--- a/actionpack/lib/action_controller/metal/redirecting.rb
+++ b/actionpack/lib/action_controller/metal/redirecting.rb
@@ -42,7 +42,8 @@ module ActionController
# redirect_to :action=>'atom', :status => 302
#
# The status code can either be a standard {HTTP Status code}[http://www.iana.org/assignments/http-status-codes] as an
- # integer, or a symbol representing the downcased, underscored and symbolized description.
+ # integer, or a symbol representing the downcased, underscored and symbolized description. Note that the status code
+ # must be a 3xx HTTP code, or redirection will not occur.
#
# It is also possible to assign a flash message as part of the redirection. There are two special accessors for commonly used the flash names
# +alert+ and +notice+ as well as a general purpose +flash+ bucket.
--
cgit v1.2.3