Permalink
Browse files

revised case of constants in Action Controller

  • Loading branch information...
1 parent 964392f commit 401690fea3d136581231444966eaa21f5c376b3b @fxn fxn committed May 21, 2008
@@ -44,8 +44,8 @@ module SelectorAssertions
# base element and any of its children. Returns an empty array if no
# match is found.
#
- # The selector may be a CSS selector expression (+String+), an expression
- # with substitution values (+Array+) or an HTML::Selector object.
+ # The selector may be a CSS selector expression (String), an expression
+ # with substitution values (Array) or an HTML::Selector object.
#
# ==== Examples
# # Selects all div tags
@@ -130,7 +130,7 @@ def css_select(*args)
# assert_select "li"
# end
#
- # The selector may be a CSS selector expression (+String+), an expression
+ # The selector may be a CSS selector expression (String), an expression
# with substitution values, or an HTML::Selector object.
#
# === Equality Tests
@@ -104,7 +104,7 @@ class UnknownHttpMethod < ActionControllerError #:nodoc:
# end
#
# Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
- # after executing code in the action. For example, the +index+ action of the +GuestBookController+ would render the
+ # after executing code in the action. For example, the +index+ action of the GuestBookController would render the
# template <tt>app/views/guestbook/index.erb</tt> by default after populating the <tt>@entries</tt> instance variable.
#
# Unlike index, the sign action will not render a template. After performing its main purpose (creating a
@@ -18,7 +18,7 @@ class Cookie < DelegateClass(Array)
# path:: the path for which this cookie applies. Defaults to the
# base directory of the CGI script.
# domain:: the domain for which this cookie applies.
- # expires:: the time at which this cookie expires, as a +Time+ object.
+ # expires:: the time at which this cookie expires, as a Time object.
# secure:: whether this cookie is a secure cookie or not (default to
# false). Secure cookies are only transmitted to HTTPS
# servers.
@@ -15,7 +15,7 @@ class Base
# * <tt>:new_session</tt> - if true, force creation of a new session. If not set, a new session is only created if none currently
# exists. If false, a new session is never created, and if none currently exists and the +session_id+ option is not set,
# an ArgumentError is raised.
- # * <tt>:session_expires</tt> - the time the current session expires, as a +Time+ object. If not set, the session will continue
+ # * <tt>:session_expires</tt> - the time the current session expires, as a Time object. If not set, the session will continue
# indefinitely.
# * <tt>:session_domain</tt> - the hostname domain for which this session is valid. If not set, defaults to the hostname of the
# server.
@@ -20,7 +20,7 @@ class << self
end
# The Rails framework provides a large number of helpers for working with +assets+, +dates+, +forms+,
- # +numbers+ and +ActiveRecord+ objects, to name a few. These helpers are available to all templates
+ # +numbers+ and Active Record 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
@@ -32,7 +32,7 @@ class << self
# 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
+ # The +to_s+ method from the Time class can be wrapped in a helper method to display a custom message if
# the Time object is blank:
#
# module FormattedTimeHelper
@@ -41,7 +41,7 @@ class << self
# end
# end
#
- # +FormattedTimeHelper+ can now be included in a controller, using the +helper+ class method:
+ # FormattedTimeHelper can now be included in a controller, using the +helper+ class method:
#
# class EventsController < ActionController::Base
# helper FormattedTimeHelper
@@ -74,22 +74,22 @@ def add_template_helper(helper_module) #:nodoc:
# The +helper+ class method can take a series of helper module names, a block, or both.
#
- # * <tt>*args</tt>: One or more +Modules+, +Strings+ or +Symbols+, or the special symbol <tt>:all</tt>.
+ # * <tt>*args</tt>: One or more modules, strings or symbols, or the special symbol <tt>:all</tt>.
# * <tt>&block</tt>: A block defining helper methods.
#
# ==== Examples
- # When the argument is a +String+ or +Symbol+, the method will provide the "_helper" suffix, require the file
+ # When the argument is a string or symbol, the method will provide the "_helper" suffix, require the file
# and include the module in the template class. The second form illustrates how to include custom helpers
# when working with namespaced controllers, or other cases where the file containing the helper definition is not
# in one of Rails' standard load paths:
# helper :foo # => requires 'foo_helper' and includes FooHelper
# helper 'resources/foo' # => requires 'resources/foo_helper' and includes Resources::FooHelper
#
- # When the argument is a +Module+, it will be included directly in the template class.
+ # When the argument is a module it will be included directly in the template class.
# helper FooHelper # => includes FooHelper
#
# When the argument is the symbol <tt>:all</tt>, the controller will include all helpers from
- # <tt>app/helpers/**/*.rb</tt> under +RAILS_ROOT+.
+ # <tt>app/helpers/**/*.rb</tt> under RAILS_ROOT.
# helper :all
#
# Additionally, the +helper+ class method can receive and evaluate a block, making the methods defined available
@@ -58,7 +58,7 @@ class Session
class MultiPartNeededException < Exception
end
- # Create and initialize a new +Session+ instance.
+ # Create and initialize a new Session instance.
def initialize
reset!
end
@@ -3,7 +3,7 @@
module ActionController #:nodoc:
class Base
- # Process a test request called with a +TestRequest+ object.
+ # Process a test request called with a TestRequest object.
def self.process_test(request)
new.process_test(request)
end

0 comments on commit 401690f

Please sign in to comment.