Browse files

Improve documentation around status code argument of redirect_to

  • Loading branch information...
1 parent b676213 commit 7e37db421804426924aac76471b164e5b2d65089 @christineyen christineyen committed with fxn Jun 15, 2011
Showing with 2 additions and 1 deletion.
  1. +2 −1 actionpack/lib/action_controller/metal/redirecting.rb
View
3 actionpack/lib/action_controller/metal/redirecting.rb
@@ -42,7 +42,8 @@ module Redirecting
# 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.

0 comments on commit 7e37db4

Please sign in to comment.