Removing ==Examples and last blank lines of docs from actionpack

10 files changed, 12 insertions, 34 deletions

diff --git a/actionpack/lib/action_controller/caching/pages.rb b/actionpack/lib/action_controller/caching/pages.rb
index 307594d54a..dd4eddbe9a 100644
--- a/actionpack/lib/action_controller/caching/pages.rb
+++ b/actionpack/lib/action_controller/caching/pages.rb
@@ -60,7 +60,8 @@ module ActionController #:nodoc:
       end
 
       module ClassMethods
-        # Expires the page that was cached with the +path+ as a key. Example:
+        # Expires the page that was cached with the +path+ as a key.
+        #
         #   expire_page "/lists/show"
         def expire_page(path)
           return unless perform_caching
@@ -72,7 +73,8 @@ module ActionController #:nodoc:
           end
         end
 
-        # Manually cache the +content+ in the key determined by +path+. Example:
+        # Manually cache the +content+ in the key determined by +path+.
+        #
         #   cache_page "I'm the cached content", "/lists/show"
         def cache_page(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
           return unless perform_caching
@@ -93,8 +95,6 @@ module ActionController #:nodoc:
         #
         # You can also pass a :gzip option to override the class configuration one.
         #
-        # Usage:
-        #
         #   # cache the index action
         #   caches_page :index
         #
@@ -142,7 +142,8 @@ module ActionController #:nodoc:
           end
       end
 
-      # Expires the page that was cached with the +options+ as a key. Example:
+      # Expires the page that was cached with the +options+ as a key.
+      #
       #   expire_page :controller => "lists", :action => "show"
       def expire_page(options = {})
         return unless self.class.perform_caching
@@ -161,7 +162,8 @@ module ActionController #:nodoc:
       end
 
       # Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used.
-      # If no options are provided, the url of the current request being handled is used. Example:
+      # If no options are provided, the url of the current request being handled is used.
+      #
       #   cache_page "I'm the cached content", :controller => "lists", :action => "show"
       def cache_page(content = nil, options = nil, gzip = Zlib::BEST_COMPRESSION)
         return unless self.class.perform_caching && caching_allowed?
diff --git a/actionpack/lib/action_controller/metal/conditional_get.rb b/actionpack/lib/action_controller/metal/conditional_get.rb
index 5b25a0d303..2193dde667 100644
--- a/actionpack/lib/action_controller/metal/conditional_get.rb
+++ b/actionpack/lib/action_controller/metal/conditional_get.rb
@@ -108,7 +108,6 @@ module ActionController
     # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a <tt>private</tt> instruction, so that
     # intermediate caches must not cache the response.
     #
-    # Examples:
     #   expires_in 20.minutes
     #   expires_in 3.hours, :public => true
     #   expires_in 3.hours, :public => true, :must_revalidate => true
diff --git a/actionpack/lib/action_controller/metal/helpers.rb b/actionpack/lib/action_controller/metal/helpers.rb
index 1a4bca12d2..86d061e3b7 100644
--- a/actionpack/lib/action_controller/metal/helpers.rb
+++ b/actionpack/lib/action_controller/metal/helpers.rb
@@ -16,7 +16,6 @@ module ActionController
   # Additional helpers can be specified using the +helper+ class method in ActionController::Base or any
   # 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
   # a \Time object is blank:
   #
diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb
index 7917926978..0b800c3c62 100644
--- a/actionpack/lib/action_controller/metal/mime_responds.rb
+++ b/actionpack/lib/action_controller/metal/mime_responds.rb
@@ -16,8 +16,6 @@ module ActionController #:nodoc:
       # Defines mime types that are rendered by default when invoking
       # <tt>respond_with</tt>.
       #
-      # Examples:
-      #
       #   respond_to :html, :xml, :json
       #
       # Specifies that all actions in the controller respond to requests
@@ -185,7 +183,6 @@ module ActionController #:nodoc:
     #   end
     #
     # Be sure to check respond_with and respond_to documentation for more examples.
-    #
     def respond_to(*mimes, &block)
       raise ArgumentError, "respond_to takes either types or a block, never both" if mimes.any? && block_given?
 
@@ -323,7 +320,6 @@ module ActionController #:nodoc:
     #    a successful html +post+ request.
     # 2. <tt>:action</tt> - overwrites the default render action used after an
     #    unsuccessful html +post+ request.
-    #
     def respond_with(*resources, &block)
       raise "In order to use respond_with, first you need to declare the formats your " <<
             "controller responds to in the class level" if self.class.mimes_for_respond_to.empty?
@@ -339,7 +335,6 @@ module ActionController #:nodoc:
 
     # Collect mimes declared in the class method respond_to valid for the
     # current action.
-    #
     def collect_mimes_from_class_level #:nodoc:
       action = action_name.to_s
 
@@ -362,7 +357,6 @@ module ActionController #:nodoc:
     #
     # Sends :not_acceptable to the client and returns nil if no suitable format
     # is available.
-    #
     def retrieve_collector_from_mimes(mimes=nil, &block) #:nodoc:
       mimes ||= collect_mimes_from_class_level
       collector = Collector.new(mimes)
@@ -401,7 +395,6 @@ module ActionController #:nodoc:
     # A subsequent call to #negotiate_format(request) will enable the Collector
     # to determine which specific mime-type it should respond with for the current
     # request, with this response then being accessible by calling #response.
-    #
     class Collector
       include AbstractController::Collector
       attr_accessor :order, :format
diff --git a/actionpack/lib/action_controller/metal/redirecting.rb b/actionpack/lib/action_controller/metal/redirecting.rb
index 5e7bd44562..4290707a64 100644
--- a/actionpack/lib/action_controller/metal/redirecting.rb
+++ b/actionpack/lib/action_controller/metal/redirecting.rb
@@ -24,7 +24,6 @@ module ActionController
     # * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places.
     #   Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt>
     #
-    # Examples:
     #   redirect_to :action => "show", :id => 5
     #   redirect_to post
     #   redirect_to "http://www.rubyonrails.org"
@@ -35,7 +34,6 @@ module ActionController
     #
     # The redirection happens as a "302 Moved" header unless otherwise specified.
     #
-    # Examples:
     #   redirect_to post_url(@post), :status => :found
     #   redirect_to :action=>'atom', :status => :moved_permanently
     #   redirect_to post_url(@post), :status => 301
@@ -51,14 +49,12 @@ module ActionController
     # around this  you can return a <tt>303 See Other</tt> status code which will be
     # followed using a GET request.
     #
-    # Examples:
     #   redirect_to posts_url, :status => :see_other
     #   redirect_to :action => 'index', :status => 303
     #
     # It is also possible to assign a flash message as part of the redirection. There are two special accessors for the commonly used flash names
     # +alert+ and +notice+ as well as a general purpose +flash+ bucket.
     #
-    # Examples:
     #   redirect_to post_url(@post), :alert => "Watch it, mister!"
     #   redirect_to post_url(@post), :status=> :found, :notice => "Pay attention to the road"
     #   redirect_to post_url(@post), :status => 301, :flash => { :updated_post_id => @post.id }
diff --git a/actionpack/lib/action_controller/metal/renderers.rb b/actionpack/lib/action_controller/metal/renderers.rb
index 4a0c1c7dd7..1927c8bdc7 100644
--- a/actionpack/lib/action_controller/metal/renderers.rb
+++ b/actionpack/lib/action_controller/metal/renderers.rb
@@ -49,7 +49,6 @@ module ActionController
     # is the value paired with its key and the second is the remaining
     # hash of options passed to +render+.
     #
-    # === Example
     # Create a csv renderer:
     #
     #   ActionController::Renderers.add :csv do |obj, options|
diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb
index 0bff1825d9..95b0e99ed5 100644
--- a/actionpack/lib/action_controller/metal/request_forgery_protection.rb
+++ b/actionpack/lib/action_controller/metal/request_forgery_protection.rb
@@ -51,8 +51,6 @@ module ActionController #:nodoc:
     module ClassMethods
       # Turn on request forgery protection. Bear in mind that only non-GET, HTML/JavaScript requests are checked.
       #
-      # Example:
-      #
       #   class FooController < ApplicationController
       #     protect_from_forgery :except => :index
       #
diff --git a/actionpack/lib/action_controller/metal/url_for.rb b/actionpack/lib/action_controller/metal/url_for.rb
index 8e7b56dbcc..e28c05cc2d 100644
--- a/actionpack/lib/action_controller/metal/url_for.rb
+++ b/actionpack/lib/action_controller/metal/url_for.rb
@@ -6,8 +6,6 @@ module ActionController
   # url options like the +host+. In order to do so, this module requires the host class
   # to implement +env+ and +request+, which need to be a Rack-compatible.
   #
-  # Example:
-  #
   #   class RootUrl
   #     include ActionController::UrlFor
   #     include Rails.application.routes.url_helpers
@@ -19,7 +17,6 @@ module ActionController
   #       @url        = root_path # named route from the application.
   #     end
   #   end
-  #
   module UrlFor
     extend ActiveSupport::Concern
 
diff --git a/actionpack/lib/action_controller/record_identifier.rb b/actionpack/lib/action_controller/record_identifier.rb
index e7af3f5b8d..16a5decc62 100644
--- a/actionpack/lib/action_controller/record_identifier.rb
+++ b/actionpack/lib/action_controller/record_identifier.rb
@@ -3,7 +3,7 @@ require 'active_support/core_ext/module'
 module ActionController
   # The record identifier encapsulates a number of naming conventions for dealing with records, like Active Records or
   # pretty much any other model type that has an id. These patterns are then used to try elevate the view actions to
-  # a higher logical level. Example:
+  # a higher logical level.
   #
   #   # routes
   #   resources :posts
@@ -30,7 +30,7 @@ module ActionController
     JOIN = '_'.freeze
     NEW = 'new'.freeze
 
-    # The DOM class convention is to use the singular form of an object or class. Examples:
+    # The DOM class convention is to use the singular form of an object or class.
     #
     #   dom_class(post)   # => "post"
     #   dom_class(Person) # => "person"
@@ -45,7 +45,7 @@ module ActionController
     end
 
     # The DOM id convention is to use the singular form of an object or class with the id following an underscore.
-    # If no id is found, prefix with "new_" instead. Examples:
+    # If no id is found, prefix with "new_" instead.
     #
     #   dom_id(Post.find(45))       # => "post_45"
     #   dom_id(Post.new)            # => "new_post"
diff --git a/actionpack/lib/action_controller/test_case.rb b/actionpack/lib/action_controller/test_case.rb
index ad02375f12..76d07891c9 100644
--- a/actionpack/lib/action_controller/test_case.rb
+++ b/actionpack/lib/action_controller/test_case.rb
@@ -56,8 +56,6 @@ module ActionController
 
     # Asserts that the request was rendered with the appropriate template file or partials.
     #
-    # ==== Examples
-    #
     #   # assert that the "new" view template was rendered
     #   assert_template "new"
     #
@@ -84,7 +82,6 @@ module ActionController
     #
     #   # assert that the "_customer" partial was rendered with a specific object
     #   assert_template :partial => '_customer', :locals => { :customer => @customer }
-    #
     def assert_template(options = {}, message = nil)
       # Force body to be read in case the
       # template is being streamed
@@ -350,7 +347,6 @@ module ActionController
   # == \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.
-  # Example:
   #
   #  assert_redirected_to page_url(:title => 'foo')
   class TestCase < ActiveSupport::TestCase
@@ -369,12 +365,11 @@ module ActionController
       module ClassMethods
 
         # Sets the controller class name. Useful if the name can't be inferred from test class.
-        # Normalizes +controller_class+ before using. Examples:
+        # Normalizes +controller_class+ before using.
         #
         #   tests WidgetController
         #   tests :widget
         #   tests 'widget'
-        #
         def tests(controller_class)
           case controller_class
           when String, Symbol