Merge pull request #18077 from claudiob/add-docs-for-test-order

Add docs for AS::TestCase::test_order

activesupport/lib/active_support.rb

@@ -73,11 +73,11 @@ def self.eager_load!
 
   @@test_order = nil
 
-  def self.test_order=(new_order)
+  def self.test_order=(new_order) # :nodoc:
     @@test_order = new_order
   end
 
-  def self.test_order
+  def self.test_order # :nodoc:
     @@test_order
   end
 end

activesupport/lib/active_support/test_case.rb

@@ -16,10 +16,25 @@ class TestCase < ::Minitest::Test
     Assertion = Minitest::Assertion
 
     class << self
+      # Sets the order in which test cases are run.
+      #
+      #   ActiveSupport::TestCase.test_order = :random # => :random
+      #
+      # Valid values are:
+      # * +:random+   (to run tests in random order)
+      # * +:parallel+ (to run tests in parallel)
+      # * +:sorted+   (to run tests alphabetically by method name)
+      # * +:alpha+    (equivalent to +:sorted+)
       def test_order=(new_order)
         ActiveSupport.test_order = new_order
       end
 
+      # Returns the order in which test cases are run.
+      #
+      #   ActiveSupport::TestCase.test_order # => :sorted
+      #
+      # Possible values are +:random+, +:parallel+, +:alpha+, +:sorted+.
+      # Defaults to +:sorted+.
       def test_order
         test_order = ActiveSupport.test_order