Added documentation for overwrite_params #2146 [Michael Shuerig]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2162 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 9 insertions, 0 deletions

diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb
index 0c229fda8d..f62a5502b4 100755
--- a/actionpack/lib/action_controller/base.rb
+++ b/actionpack/lib/action_controller/base.rb
@@ -425,6 +425,15 @@ module ActionController #:nodoc:
       #
       #   url_for :controller => 'posts', :action => nil
       #      
+      # If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
+      # :overwrite_params options. Say for your posts you have different views for showing and printing them.
+      # Then, in the show view, you get the URL for the print view like this
+      #
+      #   url_for :overwrite_params => { :action => 'print' }
+      #
+      # This takes the current URL as is and only exchanges the action. In contrast, <tt>url_for :action => 'print'</tt>
+      # would have slashed-off the path components are the changed action.
+      #
       # Instead of passing an options hash, you can also pass a method reference in the form of a symbol. Consider this example:
       #
       #   class WeblogController < ActionController::Base