Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Documentation tweaks and fixes. Closes #9454 [sur, kampers]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7383 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit ed09b621bd0ca0377de8114bcd918ab3aba38abd 1 parent 33e5e41
Jeremy Kemper jeremy authored
2  actionpack/lib/action_controller/assertions.rb
View
@@ -39,7 +39,7 @@ module ActionController #:nodoc:
#
# == Testing named routes
#
- # If you're using named routes, they can be easily tested using the original named routes methods straight in the test case.
+ # If you're using named routes, they can be easily tested using the original named routes' methods straight in the test case.
# Example:
#
# assert_redirected_to page_url(:title => 'foo')
4 actionpack/lib/action_controller/cookies.rb
View
@@ -44,8 +44,8 @@ def initialize(controller)
update(@cookies)
end
- # Returns the value of the cookie by +name+ -- or nil if no such cookie exists. You set new cookies using either the cookie method
- # or cookies[]= (for simple name/value cookies without options).
+ # Returns the value of the cookie by +name+ -- or nil if no such cookie exists. You set new cookies using cookies[]=
+ # (for simple name/value cookies without options).
def [](name)
@cookies[name.to_s].value.first if @cookies[name.to_s] && @cookies[name.to_s].respond_to?(:value)
end
2  actionpack/lib/action_controller/flash.rb
View
@@ -96,7 +96,7 @@ def keep(k = nil)
use(k, false)
end
- # Marks the entire flash or a single flash entry to be discarded by the end of the current action
+ # Marks the entire flash or a single flash entry to be discarded by the end of the current action:
#
# flash.discard # discard the entire flash at the end of the current action
# flash.discard(:warning) # discard only the "warning" entry at the end of the current action
20 actionpack/lib/action_controller/helpers.rb
View
@@ -19,16 +19,16 @@ class << self
end
# The Rails framework provides a large number of helpers for working with +assets+, +dates+, +forms+,
- # +numbers+ and <tt>Active Record objects</tt>, to name a few. These helpers are available to all templates
+ # +numbers+ and +ActiveRecord+ objects, to name a few. These helpers are available to all templates
# by default.
#
# In addition to using the standard template helpers provided in the Rails framework, creating custom helpers to
# extract complicated logic or reusable functionality is strongly encouraged. By default, the controller will
# include a helper whose name matches that of the controller, e.g., <tt>MyController</tt> will automatically
- # include <tt>MyHelper</tt>.
+ # include <tt>MyHelper</tt>.
#
# Additional helpers can be specified using the +helper+ class method in <tt>ActionController::Base</tt> or any
- # controller which inherits from it.
+ # controller which inherits from it.
#
# ==== Examples
# The +to_s+ method from the +Time+ class can be wrapped in a helper method to display a custom message if
@@ -88,7 +88,7 @@ def add_template_helper(helper_module) #:nodoc:
# helper FooHelper # => includes FooHelper
#
# When the argument is the symbol <tt>:all</tt>, the controller will includes all helpers from
- # <tt>app/views/helpers/**/*.rb</tt> under RAILS_ROOT
+ # <tt>app/views/helpers/**/*.rb</tt> under +RAILS_ROOT+.
# helper :all
#
# Additionally, the +helper+ class method can receive and evaluate a block, making the methods defined available
@@ -102,7 +102,7 @@ def add_template_helper(helper_module) #:nodoc:
# end
# end
#
- # Finally, all the above styles can be mixed together, and the helper method can be invokved with a mix of
+ # Finally, all the above styles can be mixed together, and the +helper+ method can be invokved with a mix of
# +symbols+, +strings+, +modules+ and blocks.
# helper(:three, BlindHelper) { def mice() 'mice' end }
#
@@ -139,14 +139,14 @@ def helper(*args, &block)
master_helper_module.module_eval(&block) if block_given?
end
- # Declare a controller method as a helper. For example,
+ # Declare a controller method as a helper. For example, the following
+ # makes the +current_user+ controller method available to the view:
# class ApplicationController < ActionController::Base
# helper_method :current_user
# def current_user
# @current_user ||= User.find(session[:user])
# end
# end
- # makes the +current_user+ controller method available in the view.
def helper_method(*methods)
methods.flatten.each do |method|
master_helper_module.module_eval <<-end_eval
@@ -157,11 +157,11 @@ def #{method}(*args, &block)
end
end
- # Declare a controller attribute as a helper. For example,
+ # Declares helper accessors for controller attributes. For example, the
+ # following adds new +name+ and <tt>name=</tt> instance methods to a
+ # controller and makes them available to the view:
# helper_attr :name
# attr_accessor :name
- # makes the name and name= controller methods available in the view.
- # The is a convenience wrapper for helper_method.
def helper_attr(*attrs)
attrs.flatten.each { |attr| helper_method(attr, "#{attr}=") }
end
2  actionpack/lib/action_controller/integration.rb
View
@@ -51,7 +51,7 @@ class Session
# A reference to the response instance used by the last request.
attr_reader :response
- # Create an initialize a new Session instance.
+ # Create and initialize a new +Session+ instance.
def initialize
reset!
end
Please sign in to comment.
Something went wrong with that request. Please try again.