Permalink
Browse files

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
  • Loading branch information...
1 parent 2114220 commit 09095c720406d80f5faf482a0dd840a290f1781d Marcel Molina committed Apr 25, 2006
View
@@ -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.]
@@ -263,10 +263,10 @@ class Base
# 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.
+ # <tt>params</tt> 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 <tt>params</tt>. 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:
@@ -38,9 +38,9 @@ def self.included(base) #: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
#
@@ -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
# <tt>@person_pages</tt> Paginator instance. The current page is determined
- # by the <tt>@params['page']</tt> variable.
+ # by the <tt>params[:page]</tt> 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
@@ -14,7 +14,7 @@ module Streaming
# 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:
@@ -37,7 +37,7 @@ module ClassMethods
# is a hash consisting of the following key/value pairs:
#
# * <tt>:params</tt>: 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 <tt>params</tt> hash in order for the action(s) to be safely
# called.
# * <tt>:session</tt>: a single key or an array of keys that must
# be in the @session in order for the action(s) to be safely called.
@@ -143,7 +143,7 @@ def periodically_call_remote(options = {})
# 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 <tt>params</tt>). The options for
# specifying the target with :url and defining callbacks is the same as
# link_to_remote.
#

0 comments on commit 09095c7

Please sign in to comment.