diff options
| author | Arthur Nogueira Neves <arthurnn@gmail.com> | 2014-05-21 10:58:48 -0400 |
|---|---|---|
| committer | Arthur Nogueira Neves <arthurnn@gmail.com> | 2014-05-21 10:58:48 -0400 |
| commit | 1a6b25574fdc831ff4c100642b5e0bfe529fe08f (patch) | |
| tree | 1e5ef71c68b8c7a8ae67f115d060a5800a1db961 | |
| parent | b452e4a39b8a4a8880825cc1868df656ede7d609 (diff) | |
| parent | 4e986e398f764d6347b228a815e790811359564d (diff) | |
| download | rails-1a6b25574fdc831ff4c100642b5e0bfe529fe08f.tar.gz rails-1a6b25574fdc831ff4c100642b5e0bfe529fe08f.tar.bz2 rails-1a6b25574fdc831ff4c100642b5e0bfe529fe08f.zip | |
Merge pull request #15221 from laurelfan/doc-fix-redirecting
fix formatting and text for ActionController::Redirecting doc
| -rw-r--r-- | actionpack/lib/action_controller/metal/redirecting.rb | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/actionpack/lib/action_controller/metal/redirecting.rb b/actionpack/lib/action_controller/metal/redirecting.rb index 2812038938..136e086d0d 100644 --- a/actionpack/lib/action_controller/metal/redirecting.rb +++ b/actionpack/lib/action_controller/metal/redirecting.rb @@ -14,7 +14,7 @@ module ActionController include ActionController::RackDelegation include ActionController::UrlFor - # Redirects the browser to the target specified in +options+. This parameter can take one of three forms: + # Redirects the browser to the target specified in +options+. This parameter can be any one of: # # * <tt>Hash</tt> - The URL will be generated by calling url_for with the +options+. # * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record. @@ -24,6 +24,8 @@ module ActionController # * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places. # Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt> # + # === Examples: + # # redirect_to action: "show", id: 5 # redirect_to post # redirect_to "http://www.rubyonrails.org" @@ -32,7 +34,7 @@ module ActionController # redirect_to :back # redirect_to proc { edit_post_url(@post) } # - # The redirection happens as a "302 Found" header unless otherwise specified. + # The redirection happens as a "302 Found" header unless otherwise specified using the <tt>:status</tt> option: # # redirect_to post_url(@post), status: :found # redirect_to action: 'atom', status: :moved_permanently @@ -60,8 +62,10 @@ module ActionController # redirect_to post_url(@post), status: 301, flash: { updated_post_id: @post.id } # redirect_to({ action: 'atom' }, alert: "Something serious happened") # - # When using <tt>redirect_to :back</tt>, if there is no referrer, ActionController::RedirectBackError will be raised. You may specify some fallback - # behavior for this case by rescuing ActionController::RedirectBackError. + # When using <tt>redirect_to :back</tt>, if there is no referrer, + # <tt>ActionController::RedirectBackError</tt> will be raised. You + # may specify some fallback behavior for this case by rescuing + # <tt>ActionController::RedirectBackError</tt>. def redirect_to(options = {}, response_status = {}) #:doc: raise ActionControllerError.new("Cannot redirect to nil!") unless options raise AbstractController::DoubleRenderError if response_body |