From 09095c720406d80f5faf482a0dd840a290f1781d Mon Sep 17 00:00:00 2001 From: Marcel Molina Date: Tue, 25 Apr 2006 17:42:48 +0000 Subject: Remove all remaining references to @params in the documentation. git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@4268 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- actionpack/CHANGELOG | 2 ++ actionpack/lib/action_controller/base.rb | 4 ++-- actionpack/lib/action_controller/caching.rb | 6 +++--- actionpack/lib/action_controller/pagination.rb | 4 ++-- actionpack/lib/action_controller/streaming.rb | 2 +- actionpack/lib/action_controller/verification.rb | 2 +- actionpack/lib/action_view/helpers/prototype_helper.rb | 2 +- 7 files changed, 12 insertions(+), 10 deletions(-) diff --git a/actionpack/CHANGELOG b/actionpack/CHANGELOG index 9c180eae1b..ee0ea8d2e6 100644 --- a/actionpack/CHANGELOG +++ b/actionpack/CHANGELOG @@ -1,5 +1,7 @@ *SVN* +* Remove all remaining references to @params in the documentation. [Marcel Molina Jr.] + * Add documentation for redirect_to :back's RedirectBackError exception. [Marcel Molina Jr.] * Update layout and content_for documentation to use yield rather than magic @content_for instance variables. [Marcel Molina Jr.] diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb index 3ed99ba793..16d54e5071 100755 --- a/actionpack/lib/action_controller/base.rb +++ b/actionpack/lib/action_controller/base.rb @@ -263,10 +263,10 @@ module ActionController #:nodoc: # Modern REST web services often need to submit complex data to the web application. # The param_parsers hash lets you register handlers wich will process the http body and add parameters to the - # @params hash. These handlers are invoked for post and put requests. + # params hash. These handlers are invoked for post and put requests. # # By default application/xml is enabled. A XmlSimple class with the same param name as the root will be instanciated - # in the @params. This allows XML requests to mask themselves as regular form submissions, so you can have one + # in the params. This allows XML requests to mask themselves as regular form submissions, so you can have one # action serve both regular forms and web service requests. # # Example of doing your own parser for a custom content type: diff --git a/actionpack/lib/action_controller/caching.rb b/actionpack/lib/action_controller/caching.rb index 0cb70c865a..91da89ad5a 100644 --- a/actionpack/lib/action_controller/caching.rb +++ b/actionpack/lib/action_controller/caching.rb @@ -38,9 +38,9 @@ module ActionController #:nodoc: # # class WeblogController < ActionController::Base # def update - # List.update(@params["list"]["id"], @params["list"]) - # expire_page :action => "show", :id => @params["list"]["id"] - # redirect_to :action => "show", :id => @params["list"]["id"] + # List.update(params[:list][:id], params[:list]) + # expire_page :action => "show", :id => params[:list][:id] + # redirect_to :action => "show", :id => params[:list][:id] # end # end # diff --git a/actionpack/lib/action_controller/pagination.rb b/actionpack/lib/action_controller/pagination.rb index 630b244a0e..a1053e65a7 100644 --- a/actionpack/lib/action_controller/pagination.rb +++ b/actionpack/lib/action_controller/pagination.rb @@ -31,7 +31,7 @@ module ActionController # instance variable, which is an ordered collection of model objects for the # current page (at most 20, sorted by last name and first name), and a # @person_pages Paginator instance. The current page is determined - # by the @params['page'] variable. + # by the params[:page] variable. # # ==== Pagination for a single action # @@ -47,7 +47,7 @@ module ActionController # ==== Custom/"classic" pagination # # def list - # @person_pages = Paginator.new self, Person.count, 10, @params['page'] + # @person_pages = Paginator.new self, Person.count, 10, params[:page] # @people = Person.find :all, :order => 'last_name, first_name', # :limit => @person_pages.items_per_page, # :offset => @person_pages.current.offset diff --git a/actionpack/lib/action_controller/streaming.rb b/actionpack/lib/action_controller/streaming.rb index 2c4e76f359..c265c86045 100644 --- a/actionpack/lib/action_controller/streaming.rb +++ b/actionpack/lib/action_controller/streaming.rb @@ -14,7 +14,7 @@ module ActionController #:nodoc: # it feasible to send even large files. # # Be careful to sanitize the path parameter if it coming from a web - # page. send_file(@params['path']) allows a malicious user to + # page. send_file(params[:path]) allows a malicious user to # download any file on your server. # # Options: diff --git a/actionpack/lib/action_controller/verification.rb b/actionpack/lib/action_controller/verification.rb index cba4a2b739..b12907c35f 100644 --- a/actionpack/lib/action_controller/verification.rb +++ b/actionpack/lib/action_controller/verification.rb @@ -37,7 +37,7 @@ module ActionController #:nodoc: # is a hash consisting of the following key/value pairs: # # * :params: a single key or an array of keys that must - # be in the @params hash in order for the action(s) to be safely + # be in the params hash in order for the action(s) to be safely # called. # * :session: a single key or an array of keys that must # be in the @session in order for the action(s) to be safely called. diff --git a/actionpack/lib/action_view/helpers/prototype_helper.rb b/actionpack/lib/action_view/helpers/prototype_helper.rb index 1b0a31abb5..3c4c0ba98d 100644 --- a/actionpack/lib/action_view/helpers/prototype_helper.rb +++ b/actionpack/lib/action_view/helpers/prototype_helper.rb @@ -143,7 +143,7 @@ module ActionView # background instead of the regular reloading POST arrangement. Even # though it's using JavaScript to serialize the form elements, the form # submission will work just like a regular submission as viewed by the - # receiving side (all elements available in @params). The options for + # receiving side (all elements available in params). The options for # specifying the target with :url and defining callbacks is the same as # link_to_remote. # -- cgit v1.2.3