Merge branch 'master' of github.com:lifo/docrails

Conflicts:
	actionpack/lib/action_view/helpers/asset_tag_helper.rb

10 files changed, 2 insertions, 42 deletions

diff --git a/actionpack/lib/action_dispatch/http/filter_parameters.rb b/actionpack/lib/action_dispatch/http/filter_parameters.rb
index 132b0c82bc..6413929be3 100644
--- a/actionpack/lib/action_dispatch/http/filter_parameters.rb
+++ b/actionpack/lib/action_dispatch/http/filter_parameters.rb
@@ -10,8 +10,6 @@ module ActionDispatch
     # value of the params hash and all subhashes is passed to it, the value
     # or key can be replaced using String#replace or similar method.
     #
-    # Examples:
-    #
     #   env["action_dispatch.parameter_filter"] = [:password]
     #   => replaces the value to all keys matching /password/i with "[FILTERED]"
     #
@@ -22,7 +20,6 @@ module ActionDispatch
     #     v.reverse! if k =~ /secret/i
     #   end
     #   => reverses the value to all keys matching /secret/i
-    #
     module FilterParameters
       extend ActiveSupport::Concern
 
diff --git a/actionpack/lib/action_dispatch/middleware/flash.rb b/actionpack/lib/action_dispatch/middleware/flash.rb
index 17776c2356..9928b7cc3a 100644
--- a/actionpack/lib/action_dispatch/middleware/flash.rb
+++ b/actionpack/lib/action_dispatch/middleware/flash.rb
@@ -11,7 +11,7 @@ module ActionDispatch
   # The flash provides a way to pass temporary objects between actions. Anything you place in the flash will be exposed
   # to the very next action and then cleared out. This is a great way of doing notices and alerts, such as a create
   # action that sets <tt>flash[:notice] = "Post successfully created"</tt> before redirecting to a display action that can
-  # then expose the flash to its template. Actually, that exposure is automatically done. Example:
+  # then expose the flash to its template. Actually, that exposure is automatically done.
   #
   #   class PostsController < ActionController::Base
   #     def create
diff --git a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
index dbcf703ec3..7efc094f98 100644
--- a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
+++ b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
@@ -27,7 +27,7 @@ module ActionDispatch
     #   CGI::Session instance as an argument. It's important that the secret
     #   is not vulnerable to a dictionary attack. Therefore, you should choose
     #   a secret consisting of random numbers and letters and more than 30
-    #   characters. Examples:
+    #   characters.
     #
     #     :secret => '449fe2e7daee471bffae2fd8dc02313d'
     #     :secret => Proc.new { User.current_user.secret_key }
diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb
index d6eaed4845..67a208263b 100644
--- a/actionpack/lib/action_dispatch/routing/mapper.rb
+++ b/actionpack/lib/action_dispatch/routing/mapper.rb
@@ -495,8 +495,6 @@ module ActionDispatch
         # Define a route that only recognizes HTTP GET.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        # Example:
-        #
         #   get 'bacon', :to => 'food#bacon'
         def get(*args, &block)
           map_method(:get, args, &block)
@@ -505,8 +503,6 @@ module ActionDispatch
         # Define a route that only recognizes HTTP POST.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        # Example:
-        #
         #   post 'bacon', :to => 'food#bacon'
         def post(*args, &block)
           map_method(:post, args, &block)
@@ -515,8 +511,6 @@ module ActionDispatch
         # Define a route that only recognizes HTTP PATCH.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        # Example:
-        #
         #   patch 'bacon', :to => 'food#bacon'
         def patch(*args, &block)
           map_method(:patch, args, &block)
@@ -525,8 +519,6 @@ module ActionDispatch
         # Define a route that only recognizes HTTP PUT.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        # Example:
-        #
         #   put 'bacon', :to => 'food#bacon'
         def put(*args, &block)
           map_method(:put, args, &block)
@@ -535,8 +527,6 @@ module ActionDispatch
         # Define a route that only recognizes HTTP DELETE.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        # Example:
-        #
         #   delete 'broccoli', :to => 'food#broccoli'
         def delete(*args, &block)
           map_method(:delete, args, &block)
@@ -681,7 +671,6 @@ module ActionDispatch
 
         # Scopes routes to a specific controller
         #
-        # Example:
         #   controller "food" do
         #     match "bacon", :action => "bacon"
         #   end
diff --git a/actionpack/lib/action_dispatch/routing/url_for.rb b/actionpack/lib/action_dispatch/routing/url_for.rb
index ee02f4b531..fd3bed7e8f 100644
--- a/actionpack/lib/action_dispatch/routing/url_for.rb
+++ b/actionpack/lib/action_dispatch/routing/url_for.rb
@@ -132,8 +132,6 @@ module ActionDispatch
       # Any other key (<tt>:controller</tt>, <tt>:action</tt>, etc.) given to
       # +url_for+ is forwarded to the Routes module.
       #
-      # Examples:
-      #
       #    url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :port => '8080'
       #    # => 'http://somehost.org:8080/tasks/testing'
       #    url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :anchor => 'ok', :only_path => true
diff --git a/actionpack/lib/action_dispatch/testing/assertions/dom.rb b/actionpack/lib/action_dispatch/testing/assertions/dom.rb
index edea6dab39..7dc3d0f97c 100644
--- a/actionpack/lib/action_dispatch/testing/assertions/dom.rb
+++ b/actionpack/lib/action_dispatch/testing/assertions/dom.rb
@@ -5,11 +5,8 @@ module ActionDispatch
     module DomAssertions
       # \Test two HTML strings for equivalency (e.g., identical up to reordering of attributes)
       #
-      # ==== Examples
-      #
       #   # assert that the referenced method generates the appropriate HTML string
       #   assert_dom_equal '<a href="http://www.example.com">Apples</a>', link_to("Apples", "http://www.example.com")
-      #
       def assert_dom_equal(expected, actual, message = "")
         expected_dom = HTML::Document.new(expected).root
         actual_dom   = HTML::Document.new(actual).root
@@ -18,11 +15,8 @@ module ActionDispatch
 
       # The negated form of +assert_dom_equivalent+.
       #
-      # ==== Examples
-      #
       #   # assert that the referenced method does not generate the specified HTML string
       #   assert_dom_not_equal '<a href="http://www.example.com">Apples</a>', link_to("Oranges", "http://www.example.com")
-      #
       def assert_dom_not_equal(expected, actual, message = "")
         expected_dom = HTML::Document.new(expected).root
         actual_dom   = HTML::Document.new(actual).root
diff --git a/actionpack/lib/action_dispatch/testing/assertions/response.rb b/actionpack/lib/action_dispatch/testing/assertions/response.rb
index 8f6fff5d32..3d121b6b9c 100644
--- a/actionpack/lib/action_dispatch/testing/assertions/response.rb
+++ b/actionpack/lib/action_dispatch/testing/assertions/response.rb
@@ -15,14 +15,11 @@ module ActionDispatch
       # or its symbolic equivalent <tt>assert_response(:not_implemented)</tt>.
       # See Rack::Utils::SYMBOL_TO_STATUS_CODE for a full list.
       #
-      # ==== Examples
-      #
       #   # assert that the response was a redirection
       #   assert_response :redirect
       #
       #   # assert that the response code was status code 401 (unauthorized)
       #   assert_response 401
-      #
       def assert_response(type, message = nil)
         message ||= "Expected response to be a <#{type}>, but was <#{@response.response_code}>"
 
@@ -42,8 +39,6 @@ module ActionDispatch
       # This match can be partial, such that <tt>assert_redirected_to(:controller => "weblog")</tt> will also
       # match the redirection of <tt>redirect_to(:controller => "weblog", :action => "show")</tt> and so on.
       #
-      # ==== Examples
-      #
       #   # assert that the redirection was to the "index" action on the WeblogController
       #   assert_redirected_to :controller => "weblog", :action => "index"
       #
@@ -55,7 +50,6 @@ module ActionDispatch
       #
       #   # asserts that the redirection matches the regular expression
       #   assert_redirected_to %r(\Ahttp://example.org)
-      #
       def assert_redirected_to(options = {}, message=nil)
         assert_response(:redirect, message)
         return true if options === @response.location
diff --git a/actionpack/lib/action_dispatch/testing/assertions/routing.rb b/actionpack/lib/action_dispatch/testing/assertions/routing.rb
index 1f4b905d18..567ca0c392 100644
--- a/actionpack/lib/action_dispatch/testing/assertions/routing.rb
+++ b/actionpack/lib/action_dispatch/testing/assertions/routing.rb
@@ -26,7 +26,6 @@ module ActionDispatch
       #
       # The +message+ parameter allows you to pass in an error message that is displayed upon failure.
       #
-      # ==== Examples
       #   # Check the default route (i.e., the index action)
       #   assert_recognizes({:controller => 'items', :action => 'index'}, 'items')
       #
@@ -57,7 +56,6 @@ module ActionDispatch
       #
       # The +defaults+ parameter is unused.
       #
-      # ==== Examples
       #   # Asserts that the default action is generated for a route with no action
       #   assert_generates "/items", :controller => "items", :action => "index"
       #
@@ -100,7 +98,6 @@ module ActionDispatch
       # The +extras+ hash allows you to specify options that would normally be provided as a query string to the action. The
       # +message+ parameter allows you to specify a custom error message to display upon failure.
       #
-      # ==== Examples
       #  # Assert a basic route: a controller with the default action (index)
       #  assert_routing '/home', :controller => 'home', :action => 'index'
       #
diff --git a/actionpack/lib/action_dispatch/testing/assertions/selector.rb b/actionpack/lib/action_dispatch/testing/assertions/selector.rb
index ea1ed20f3c..5f9c3bbf48 100644
--- a/actionpack/lib/action_dispatch/testing/assertions/selector.rb
+++ b/actionpack/lib/action_dispatch/testing/assertions/selector.rb
@@ -39,7 +39,6 @@ module ActionDispatch
       # 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
       #   divs = css_select("div")
       #
@@ -58,7 +57,6 @@ module ActionDispatch
       #     inputs = css_select(form, "input")
       #     ...
       #   end
-      #
       def css_select(*args)
         # See assert_select to understand what's going on here.
         arg = args.shift
@@ -340,7 +338,6 @@ module ActionDispatch
       # The content of each element is un-encoded, and wrapped in the root
       # element +encoded+. It then calls the block with all un-encoded elements.
       #
-      # ==== Examples
       #   # Selects all bold tags from within the title of an Atom feed's entries (perhaps to nab a section name prefix)
       #   assert_select "feed[xmlns='http://www.w3.org/2005/Atom']" do
       #     # Select each entry item and then the title item
@@ -401,8 +398,6 @@ module ActionDispatch
       # You must enable deliveries for this assertion to work, use:
       #   ActionMailer::Base.perform_deliveries = true
       #
-      # ==== Examples
-      #
       #  assert_select_email do
       #    assert_select "h1", "Email alert"
       #  end
@@ -413,7 +408,6 @@ module ActionDispatch
       #       # Work with items here...
       #    end
       #  end
-      #
       def assert_select_email(&block)
         deliveries = ActionMailer::Base.deliveries
         assert !deliveries.empty?, "No e-mail in delivery list"
diff --git a/actionpack/lib/action_dispatch/testing/assertions/tag.rb b/actionpack/lib/action_dispatch/testing/assertions/tag.rb
index 5c735e61b2..68f1347e7c 100644
--- a/actionpack/lib/action_dispatch/testing/assertions/tag.rb
+++ b/actionpack/lib/action_dispatch/testing/assertions/tag.rb
@@ -48,8 +48,6 @@ module ActionDispatch
       # * if the condition is +true+, the value must not be +nil+.
       # * if the condition is +false+ or +nil+, the value must be +nil+.
       #
-      # === Examples
-      #
       #   # Assert that there is a "span" tag
       #   assert_tag :tag => "span"
       #
@@ -104,7 +102,6 @@ module ActionDispatch
       # Identical to +assert_tag+, but asserts that a matching tag does _not_
       # exist. (See +assert_tag+ for a full discussion of the syntax.)
       #
-      # === Examples
       #   # Assert that there is not a "div" containing a "p"
       #   assert_no_tag :tag => "div", :descendant => { :tag => "p" }
       #