add documentation for `ActiveSupport::Testing::SetupAndTeardown`.

1 files changed, 17 insertions, 2 deletions

diff --git a/activesupport/lib/active_support/testing/setup_and_teardown.rb b/activesupport/lib/active_support/testing/setup_and_teardown.rb
index a65148cf1f..33f2b8dc9b 100644
--- a/activesupport/lib/active_support/testing/setup_and_teardown.rb
+++ b/activesupport/lib/active_support/testing/setup_and_teardown.rb
@@ -3,6 +3,19 @@ require 'active_support/callbacks'
 
 module ActiveSupport
   module Testing
+    # Adds support for +setup+ and +teardown+ callbacks.
+    # These callbacks serve as a replacement to overwriting the
+    # <tt>#setup</tt> and <tt>#teardown</tt> methods of your TestCase.
+    #
+    #   class ExampleTest < ActiveSupport::TestCase
+    #     setup do
+    #       # ...
+    #     end
+    #
+    #     teardown do
+    #       # ...
+    #     end
+    #   end
     module SetupAndTeardown
       extend ActiveSupport::Concern
 
@@ -12,21 +25,23 @@ module ActiveSupport
       end
 
       module ClassMethods
+        # Add a callback, which runs before <tt>TestCase#setup</tt>.
         def setup(*args, &block)
           set_callback(:setup, :before, *args, &block)
         end
 
+        # Add a callback, which runs after <tt>TestCase#teardown</tt>.
         def teardown(*args, &block)
           set_callback(:teardown, :after, *args, &block)
         end
       end
 
-      def before_setup
+      def before_setup # :nodoc:
         super
         run_callbacks :setup
       end
 
-      def after_teardown
+      def after_teardown # :nodoc:
         run_callbacks :teardown
         super
       end