Improve documentation around status code argument of redirect_to

This commit is contained in:
Christine Yen
2011-06-15 01:55:57 -07:00
parent 045d9d2bae
commit 8da91036c0

View File

@@ -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.