Merge docrails

10 files changed, 83 insertions, 85 deletions

diff --git a/actionpack/lib/action_controller/base/http_authentication.rb b/actionpack/lib/action_controller/base/http_authentication.rb
index 2519f55269..525787bf92 100644
--- a/actionpack/lib/action_controller/base/http_authentication.rb
+++ b/actionpack/lib/action_controller/base/http_authentication.rb
@@ -276,7 +276,7 @@ module ActionController
       #
       # The nonce is opaque to the client. Composed of Time, and hash of Time with secret
       # key from the Rails session secret generated upon creation of project. Ensures
-      # the time cannot be modifed by client.
+      # the time cannot be modified by client.
       def nonce(time = Time.now)
         t = time.to_i
         hashed = [t, secret_key]
diff --git a/actionpack/lib/action_controller/base/request_forgery_protection.rb b/actionpack/lib/action_controller/base/request_forgery_protection.rb
index 6ba86cd0be..ad06657f86 100644
--- a/actionpack/lib/action_controller/base/request_forgery_protection.rb
+++ b/actionpack/lib/action_controller/base/request_forgery_protection.rb
@@ -106,8 +106,7 @@ module ActionController #:nodoc:
         !request.content_type.nil? && request.content_type.verify_request?
       end
     
-      # Sets the token value for the current session.  Pass a <tt>:secret</tt> option
-      # in +protect_from_forgery+ to add a custom salt to the hash.
+      # Sets the token value for the current session.
       def form_authenticity_token
         session[:_csrf_token] ||= ActiveSupport::SecureRandom.base64(32)
       end
diff --git a/actionpack/lib/action_controller/routing.rb b/actionpack/lib/action_controller/routing.rb
index ce59866531..5b9ded83dd 100644
--- a/actionpack/lib/action_controller/routing.rb
+++ b/actionpack/lib/action_controller/routing.rb
@@ -139,7 +139,7 @@ module ActionController
   #   # In routes.rb
   #   map.with_options :controller => 'blog' do |blog|
   #     blog.show    '',            :action  => 'list'
-  #     blog.delete  'delete/:id',  :action  => 'delete',
+  #     blog.delete  'delete/:id',  :action  => 'delete'
   #     blog.edit    'edit/:id',    :action  => 'edit'
   #   end
   #
diff --git a/actionpack/lib/action_controller/routing/generation/url_rewriter.rb b/actionpack/lib/action_controller/routing/generation/url_rewriter.rb
index 16720b915b..9717582b5e 100644
--- a/actionpack/lib/action_controller/routing/generation/url_rewriter.rb
+++ b/actionpack/lib/action_controller/routing/generation/url_rewriter.rb
@@ -93,7 +93,7 @@ module ActionController
     #
     # * <tt>:only_path</tt> - If true, the relative url is returned. Defaults to +false+.
     # * <tt>:protocol</tt> - The protocol to connect to. Defaults to 'http'.
-    # * <tt>:host</tt> - Specifies the host the link should be targetted at.
+    # * <tt>:host</tt> - Specifies the host the link should be targeted at.
     #   If <tt>:only_path</tt> is false, this option must be
     #   provided either explicitly, or via +default_url_options+.
     # * <tt>:port</tt> - Optionally specify the port to connect to.
diff --git a/actionpack/lib/action_controller/routing/route_set.rb b/actionpack/lib/action_controller/routing/route_set.rb
index f5a4b1e1db..040a7e2cb6 100644
--- a/actionpack/lib/action_controller/routing/route_set.rb
+++ b/actionpack/lib/action_controller/routing/route_set.rb
@@ -155,7 +155,7 @@ module ActionController
 
           def define_url_helper(route, name, kind, options)
             selector = url_helper_name(name, kind)
-            # The segment keys used for positional paramters
+            # The segment keys used for positional parameters
 
             hash_access_method = hash_access_name(name, kind)
 
diff --git a/actionpack/lib/action_controller/testing/test_case.rb b/actionpack/lib/action_controller/testing/test_case.rb
index 7b4eda58e5..a11755b517 100644
--- a/actionpack/lib/action_controller/testing/test_case.rb
+++ b/actionpack/lib/action_controller/testing/test_case.rb
@@ -56,7 +56,7 @@ module ActionController
   #
   # ActionController::TestCase will automatically infer the controller under test
   # from the test class name. If the controller cannot be inferred from the test
-  # class name, you can explicity set it with +tests+.
+  # class name, you can explicitly set it with +tests+.
   #
   #   class SpecialEdgeCaseWidgetsControllerTest < ActionController::TestCase
   #     tests WidgetController
@@ -182,7 +182,7 @@ module ActionController
         @controller.send(:initialize_current_url)
       end
     end
-    
+
     # Cause the action to be rescued according to the regular rules for rescue_action when the visitor is not local
     def rescue_action_in_public!
       @request.remote_addr = '208.77.188.166' # example.com
diff --git a/actionpack/lib/action_view/helpers/date_helper.rb b/actionpack/lib/action_view/helpers/date_helper.rb
index 72fe9a3232..332743d55b 100644
--- a/actionpack/lib/action_view/helpers/date_helper.rb
+++ b/actionpack/lib/action_view/helpers/date_helper.rb
@@ -112,12 +112,12 @@ module ActionView
       # ==== Options
       # * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g.
       #   "2" instead of "February").
-      # * <tt>:use_short_month</tt>   - Set to true if you want to use the abbreviated month name instead of the full
-      #   name (e.g. "Feb" instead of "February").
-      # * <tt>:add_month_number</tt>  - Set to true if you want to show both, the month's number and name (e.g.
+      # * <tt>:use_short_month</tt>   - Set to true if you want to use abbreviated month names instead of full
+      #   month names (e.g. "Feb" instead of "February").
+      # * <tt>:add_month_numbers</tt>  - Set to true if you want to use both month numbers and month names (e.g.
       #   "2 - February" instead of "February").
       # * <tt>:use_month_names</tt>   - Set to an array with 12 month names if you want to customize month names.
-      #   Note: You can also use Rails' new i18n functionality for this.
+      #   Note: You can also use Rails' i18n functionality for this.
       # * <tt>:date_separator</tt>    - Specifies a string to separate the date fields. Default is "" (i.e. nothing).
       # * <tt>:start_year</tt>        - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>.
       # * <tt>:end_year</tt>          - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>.
@@ -128,7 +128,7 @@ module ActionView
       #   as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true.
       # * <tt>:discard_year</tt>      - Set to true if you don't want to show a year select. This includes the year
       #   as a hidden field instead of showing a select field.
-      # * <tt>:order</tt>             - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> do
+      # * <tt>:order</tt>             - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> to
       #   customize the order in which the select fields are shown. If you leave out any of the symbols, the respective
       #   select will not be shown (like when you set <tt>:discard_xxx => true</tt>. Defaults to the order defined in
       #   the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails).
diff --git a/actionpack/lib/action_view/helpers/form_options_helper.rb b/actionpack/lib/action_view/helpers/form_options_helper.rb
index 6adbab175f..8cb5882aab 100644
--- a/actionpack/lib/action_view/helpers/form_options_helper.rb
+++ b/actionpack/lib/action_view/helpers/form_options_helper.rb
@@ -167,31 +167,31 @@ module ActionView
       #
       # In addition to the <tt>:include_blank</tt> option documented above,
       # this method also supports a <tt>:model</tt> option, which defaults
-      # to TimeZone. This may be used by users to specify a different time
-      # zone model object. (See +time_zone_options_for_select+ for more
-      # information.)
+      # to ActiveSupport::TimeZone. This may be used by users to specify a
+      # different time zone model object. (See +time_zone_options_for_select+
+      # for more information.)
       #
-      # You can also supply an array of TimeZone objects
+      # You can also supply an array of ActiveSupport::TimeZone objects
       # as +priority_zones+, so that they will be listed above the rest of the
-      # (long) list. (You can use TimeZone.us_zones as a convenience for
-      # obtaining a list of the US time zones, or a Regexp to select the zones
+      # (long) list. (You can use ActiveSupport::TimeZone.us_zones as a convenience
+      # for obtaining a list of the US time zones, or a Regexp to select the zones
       # of your choice)
       #
       # Finally, this method supports a <tt>:default</tt> option, which selects
-      # a default TimeZone if the object's time zone is +nil+.
+      # a default ActiveSupport::TimeZone if the object's time zone is +nil+.
       #
       # Examples:
       #   time_zone_select( "user", "time_zone", nil, :include_blank => true)
       #
       #   time_zone_select( "user", "time_zone", nil, :default => "Pacific Time (US & Canada)" )
       #
-      #   time_zone_select( "user", 'time_zone', TimeZone.us_zones, :default => "Pacific Time (US & Canada)")
+      #   time_zone_select( "user", 'time_zone', ActiveSupport::TimeZone.us_zones, :default => "Pacific Time (US & Canada)")
       #
-      #   time_zone_select( "user", 'time_zone', [ TimeZone['Alaska'], TimeZone['Hawaii'] ])
+      #   time_zone_select( "user", 'time_zone', [ ActiveSupport::TimeZone['Alaska'], ActiveSupport::TimeZone['Hawaii'] ])
       #
       #   time_zone_select( "user", 'time_zone', /Australia/)
       #
-      #   time_zone_select( "user", "time_zone", TZInfo::Timezone.all.sort, :model => TZInfo::Timezone)
+      #   time_zone_select( "user", "time_zone", ActiveSupport::Timezone.all.sort, :model => ActiveSupport::Timezone)
       def time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {})
         InstanceTag.new(object, method, self,  options.delete(:object)).to_time_zone_select_tag(priority_zones, options, html_options)
       end
@@ -393,20 +393,20 @@ module ActionView
       end
 
       # Returns a string of option tags for pretty much any time zone in the
-      # world. Supply a TimeZone name as +selected+ to have it marked as the
-      # selected option tag. You can also supply an array of TimeZone objects
-      # as +priority_zones+, so that they will be listed above the rest of the
-      # (long) list. (You can use TimeZone.us_zones as a convenience for
-      # obtaining a list of the US time zones, or a Regexp to select the zones
-      # of your choice)
+      # world. Supply a ActiveSupport::TimeZone name as +selected+ to have it
+      # marked as the selected option tag. You can also supply an array of
+      # ActiveSupport::TimeZone objects as +priority_zones+, so that they will
+      # be listed above the rest of the (long) list. (You can use
+      # ActiveSupport::TimeZone.us_zones as a convenience for obtaining a list
+      # of the US time zones, or a Regexp to select the zones of your choice)
       #
       # The +selected+ parameter must be either +nil+, or a string that names
-      # a TimeZone.
+      # a ActiveSupport::TimeZone.
       #
-      # By default, +model+ is the TimeZone constant (which can be obtained
-      # in Active Record as a value object). The only requirement is that the
-      # +model+ parameter be an object that responds to +all+, and returns
-      # an array of objects that represent time zones.
+      # By default, +model+ is the ActiveSupport::TimeZone constant (which can
+      # be obtained in Active Record as a value object). The only requirement
+      # is that the +model+ parameter be an object that responds to +all+, and
+      # returns an array of objects that represent time zones.
       #
       # NOTE: Only the option tags are returned, you have to wrap this call in
       # a regular HTML select tag.
diff --git a/actionpack/lib/action_view/helpers/text_helper.rb b/actionpack/lib/action_view/helpers/text_helper.rb
index ad0733a7e1..c3ce4c671e 100644
--- a/actionpack/lib/action_view/helpers/text_helper.rb
+++ b/actionpack/lib/action_view/helpers/text_helper.rb
@@ -436,7 +436,7 @@ module ActionView
       end
 
       # Returns the current cycle string after a cycle has been started. Useful
-      # for complex table highlighing or any other design need which requires
+      # for complex table highlighting or any other design need which requires
       # the current cycle string in more than one place.
       #
       # ==== Example
@@ -544,7 +544,7 @@ module ActionView
             left, right = $`, $'
             # detect already linked URLs and URLs in the middle of a tag
             if left =~ /<[^>]+$/ && right =~ /^[^>]*>/
-              # do not change string; URL is alreay linked
+              # do not change string; URL is already linked
               href
             else
               # don't include trailing punctuation character as part of the URL
diff --git a/actionpack/lib/action_view/helpers/url_helper.rb b/actionpack/lib/action_view/helpers/url_helper.rb
index de864f453c..c5a6d1f084 100644
--- a/actionpack/lib/action_view/helpers/url_helper.rb
+++ b/actionpack/lib/action_view/helpers/url_helper.rb
@@ -12,11 +12,11 @@ module ActionView
 
       # Returns the URL for the set of +options+ provided. This takes the
       # same options as +url_for+ in Action Controller (see the
-      # documentation for ActionController::Base#url_for). Note that by default
-      # <tt>:only_path</tt> is <tt>true</tt> so you'll get the relative /controller/action
-      # instead of the fully qualified URL like http://example.com/controller/action.
+      # documentation for <tt>ActionController::Base#url_for</tt>). Note that by default
+      # <tt>:only_path</tt> is <tt>true</tt> so you'll get the relative "/controller/action"
+      # instead of the fully qualified URL like "http://example.com/controller/action".
       #
-      # When called from a view, url_for returns an HTML escaped url. If you
+      # When called from a view, +url_for+ returns an HTML escaped url. If you
       # need an unescaped url, pass <tt>:escape => false</tt> in the +options+.
       #
       # ==== Options
@@ -34,8 +34,8 @@ module ActionView
       #
       # If you instead of a hash pass a record (like an Active Record or Active Resource) as the options parameter,
       # you'll trigger the named route for that record. The lookup will happen on the name of the class. So passing
-      # a Workshop object will attempt to use the workshop_path route. If you have a nested route, such as
-      # admin_workshop_path you'll have to call that explicitly (it's impossible for url_for to guess that route).
+      # a Workshop object will attempt to use the +workshop_path+ route. If you have a nested route, such as
+      # +admin_workshop_path+ you'll have to call that explicitly (it's impossible for +url_for+ to guess that route).
       #
       # ==== Examples
       #   <%= url_for(:action => 'index') %>
@@ -97,10 +97,10 @@ module ActionView
 
       # Creates a link tag of the given +name+ using a URL created by the set
       # of +options+. See the valid options in the documentation for
-      # url_for. It's also possible to pass a string instead
+      # +url_for+. It's also possible to pass a string instead
       # of an options hash to get a link tag that uses the value of the string as the
       # href for the link, or use <tt>:back</tt> to link to the referrer - a JavaScript back
-      # link will be used in place of a referrer if none exists. If nil is passed as
+      # link will be used in place of a referrer if none exists. If +nil+ is passed as
       # a name, the link itself will become the name.
       #
       # ==== Signatures
@@ -117,27 +117,22 @@ module ActionView
       # * <tt>:popup => true || array of window options</tt> - This will force the
       #   link to open in a popup window. By passing true, a default browser window
       #   will be opened with the URL. You can also specify an array of options
-      #   that are passed-thru to JavaScripts window.open method.
+      #   that are passed to the <tt>window.open</tt> JavaScript call.
       # * <tt>:method => symbol of HTTP verb</tt> - This modifier will dynamically
       #   create an HTML form and immediately submit the form for processing using
       #   the HTTP verb specified. Useful for having links perform a POST operation
       #   in dangerous actions like deleting a record (which search bots can follow
       #   while spidering your site). Supported verbs are <tt>:post</tt>, <tt>:delete</tt> and <tt>:put</tt>.
       #   Note that if the user has JavaScript disabled, the request will fall back
-      #   to using GET. If you are relying on the POST behavior, you should check
-      #   for it in your controller's action by using the request object's methods
-      #   for <tt>post?</tt>, <tt>delete?</tt> or <tt>put?</tt>.
+      #   to using GET. If <tt>:href => '#'</tt> is used and the user has JavaScript
+      #   disabled clicking the link will have no effect. If you are relying on the
+      #   POST behavior, you should check for it in your controller's action by using
+      #   the request object's methods for <tt>post?</tt>, <tt>delete?</tt> or <tt>put?</tt>.
       # * The +html_options+ will accept a hash of html attributes for the link tag.
       #
-      # Note that if the user has JavaScript disabled, the request will fall back
-      # to using GET. If <tt>:href => '#'</tt> is used and the user has JavaScript disabled
-      # clicking the link will have no effect. If you are relying on the POST
-      # behavior, your should check for it in your controller's action by using the
-      # request object's methods for <tt>post?</tt>, <tt>delete?</tt> or <tt>put?</tt>.
-      #
       # You can mix and match the +html_options+ with the exception of
-      # <tt>:popup</tt> and <tt>:method</tt> which will raise an ActionView::ActionViewError
-      # exception.
+      # <tt>:popup</tt> and <tt>:method</tt> which will raise an
+      # <tt>ActionView::ActionViewError</tt> exception.
       #
       # ==== Examples
       # Because it relies on +url_for+, +link_to+ supports both older-style controller/action/id arguments
@@ -170,9 +165,11 @@ module ActionView
       # You can use a block as well if your link target is hard to fit into the name parameter. ERb example:
       #
       #   <% link_to(@profile) do %>
-      #     <strong><%= @profile.name %></strong> -- <span>Check it out!!</span>
+      #     <strong><%= @profile.name %></strong> -- <span>Check it out!</span>
       #   <% end %>
-      #   # => <a href="/profiles/1"><strong>David</strong> -- <span>Check it out!!</span></a>
+      #   # => <a href="/profiles/1">
+      #          <strong>David</strong> -- <span>Check it out!</span>
+      #        </a>
       #
       # Classes and ids for CSS are easy to produce:
       #
@@ -215,7 +212,9 @@ module ActionView
       #   # => <a href="/images/9" onclick="if (confirm('Are you sure?')) { var f = document.createElement('form');
       #        f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;
       #        var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method');
-      #        m.setAttribute('value', 'delete'); f.appendChild(m);f.submit(); };return false;">Delete Image</a>
+      #        m.setAttribute('value', 'delete');var s = document.createElement('input'); s.setAttribute('type', 'hidden');
+      #        s.setAttribute('name', 'authenticity_token'); s.setAttribute('value', 'Q/ttlxPYZ6R77B+vZ1sBkhj21G2isO9dpE6UtOHBApg=');
+      #        f.appendChild(s)f.appendChild(m);f.submit(); };return false;">Delete Image</a>
       def link_to(*args, &block)
         if block_given?
           options      = args.first || {}
@@ -246,21 +245,21 @@ module ActionView
       # by the set of +options+. This is the safest method to ensure links that
       # cause changes to your data are not triggered by search bots or accelerators.
       # If the HTML button does not work with your layout, you can also consider
-      # using the link_to method with the <tt>:method</tt> modifier as described in
-      # the link_to documentation.
+      # using the +link_to+ method with the <tt>:method</tt> modifier as described in
+      # the +link_to+ documentation.
       #
-      # The generated FORM element has a class name of <tt>button-to</tt>
+      # The generated form element has a class name of <tt>button-to</tt>
       # to allow styling of the form itself and its children. You can control
       # the form submission and input element behavior using +html_options+.
       # This method accepts the <tt>:method</tt> and <tt>:confirm</tt> modifiers
-      # described in the link_to documentation. If no <tt>:method</tt> modifier
+      # described in the +link_to+ documentation. If no <tt>:method</tt> modifier
       # is given, it will default to performing a POST operation. You can also
       # disable the button by passing <tt>:disabled => true</tt> in +html_options+.
       # If you are using RESTful routes, you can pass the <tt>:method</tt>
       # to change the HTTP verb used to submit the form.
       #
       # ==== Options
-      # The +options+ hash accepts the same options at url_for.
+      # The +options+ hash accepts the same options as url_for.
       #
       # There are a few special +html_options+:
       # * <tt>:method</tt> - Specifies the anchor name to be appended to the path.
@@ -317,7 +316,7 @@ module ActionView
       # Creates a link tag of the given +name+ using a URL created by the set of
       # +options+ unless the current request URI is the same as the links, in
       # which case only the name is returned (or the given block is yielded, if
-      # one exists).  You can give link_to_unless_current a block which will
+      # one exists).  You can give +link_to_unless_current+ a block which will
       # specialize the default behavior (e.g., show a "Start Here" link rather
       # than the link's text).
       #
@@ -343,7 +342,7 @@ module ActionView
       #     <li><a href="/controller/about">About Us</a></li>
       #   </ul>
       #
-      # The implicit block given to link_to_unless_current is evaluated if the current
+      # The implicit block given to +link_to_unless_current+ is evaluated if the current
       # action is the action given.  So, if we had a comments page and wanted to render a
       # "Go Back" link instead of a link to the comments page, we could do something like this...
       #
@@ -360,7 +359,7 @@ module ActionView
       # +options+ unless +condition+ is true, in which case only the name is
       # returned. To specialize the default behavior (i.e., show a login link rather
       # than just the plaintext link text), you can pass a block that
-      # accepts the name or the full argument list for link_to_unless.
+      # accepts the name or the full argument list for +link_to_unless+.
       #
       # ==== Examples
       #   <%= link_to_unless(@current_user.nil?, "Reply", { :action => "reply" }) %>
@@ -391,8 +390,8 @@ module ActionView
       # Creates a link tag of the given +name+ using a URL created by the set of
       # +options+ if +condition+ is true, in which case only the name is
       # returned. To specialize the default behavior, you can pass a block that
-      # accepts the name or the full argument list for link_to_unless (see the examples
-      # in link_to_unless).
+      # accepts the name or the full argument list for +link_to_unless+ (see the examples
+      # in +link_to_unless+).
       #
       # ==== Examples
       #   <%= link_to_if(@current_user.nil?, "Login", { :controller => "sessions", :action => "new" }) %>
@@ -416,27 +415,27 @@ module ActionView
       # also used as the name of the link unless +name+ is specified. Additional
       # HTML attributes for the link can be passed in +html_options+.
       #
-      # mail_to has several methods for hindering email harvesters and customizing
+      # +mail_to+ has several methods for hindering email harvesters and customizing
       # the email itself by passing special keys to +html_options+.
       #
       # ==== Options
-      # * <tt>:encode</tt>  - This key will accept the strings "javascript" or "hex".
-      #   Passing "javascript" will dynamically create and encode the mailto: link then
+      # * <tt>:encode</tt> - This key will accept the strings "javascript" or "hex".
+      #   Passing "javascript" will dynamically create and encode the mailto link then
       #   eval it into the DOM of the page. This method will not show the link on
       #   the page if the user has JavaScript disabled. Passing "hex" will hex
-      #   encode the +email_address+ before outputting the mailto: link.
-      # * <tt>:replace_at</tt>  - When the link +name+ isn't provided, the
+      #   encode the +email_address+ before outputting the mailto link.
+      # * <tt>:replace_at</tt> - When the link +name+ isn't provided, the
       #   +email_address+ is used for the link label. You can use this option to
       #   obfuscate the +email_address+ by substituting the @ sign with the string
       #   given as the value.
-      # * <tt>:replace_dot</tt>  - When the link +name+ isn't provided, the
+      # * <tt>:replace_dot</tt> - When the link +name+ isn't provided, the
       #   +email_address+ is used for the link label. You can use this option to
       #   obfuscate the +email_address+ by substituting the . in the email with the
       #   string given as the value.
-      # * <tt>:subject</tt>  - Preset the subject line of the email.
+      # * <tt>:subject</tt> - Preset the subject line of the email.
       # * <tt>:body</tt> - Preset the body of the email.
-      # * <tt>:cc</tt>  - Carbon Copy addition recipients on the email.
-      # * <tt>:bcc</tt>  - Blind Carbon Copy additional recipients on the email.
+      # * <tt>:cc</tt> - Carbon Copy addition recipients on the email.
+      # * <tt>:bcc</tt> - Blind Carbon Copy additional recipients on the email.
       #
       # ==== Examples
       #   mail_to "me@domain.com"
@@ -607,23 +606,23 @@ module ActionView
           submit_function << "f.submit();"
         end
 
-        # Processes the _html_options_ hash, converting the boolean
+        # Processes the +html_options+ hash, converting the boolean
         # attributes from true/false form into the form required by
         # HTML/XHTML.  (An attribute is considered to be boolean if
-        # its name is listed in the given _bool_attrs_ array.)
+        # its name is listed in the given +bool_attrs+ array.)
         #
-        # More specifically, for each boolean attribute in _html_options_
+        # More specifically, for each boolean attribute in +html_options+
         # given as:
         #
-        #     "attr" => bool_value
+        #   "attr" => bool_value
         #
-        # if the associated _bool_value_ evaluates to true, it is
+        # if the associated +bool_value+ evaluates to true, it is
         # replaced with the attribute's name; otherwise the attribute is
-        # removed from the _html_options_ hash.  (See the XHTML 1.0 spec,
+        # removed from the +html_options+ hash.  (See the XHTML 1.0 spec,
         # section 4.5 "Attribute Minimization" for more:
         # http://www.w3.org/TR/xhtml1/#h-4.5)
         #
-        # Returns the updated _html_options_ hash, which is also modified
+        # Returns the updated +html_options+ hash, which is also modified
         # in place.
         #
         # Example: