aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack
diff options
context:
space:
mode:
authorChristine Yen <cyen@christineyen.com>2011-06-15 01:55:57 -0700
committerChristine Yen <cyen@christineyen.com>2011-06-15 01:55:57 -0700
commit8da91036c0f6b4caf10e46db07f04d49398eea28 (patch)
tree41f92c02dbf175c1b4ce572f3751a2cc3e653d9e /actionpack
parent045d9d2baeb0e733edcd7b1815132ac2a48b2d5a (diff)
downloadrails-8da91036c0f6b4caf10e46db07f04d49398eea28.tar.gz
rails-8da91036c0f6b4caf10e46db07f04d49398eea28.tar.bz2
rails-8da91036c0f6b4caf10e46db07f04d49398eea28.zip
Improve documentation around status code argument of redirect_to
Diffstat (limited to 'actionpack')
-rw-r--r--actionpack/lib/action_controller/metal/redirecting.rb3
1 files changed, 2 insertions, 1 deletions
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.