Merge pull request rails#46512 from p8/activesupport/fix-code-example-spacing

Use 2 spaces for identation in ActiveSupport code examples [ci-skip]

Author: p8

activesupport/lib/active_support/core_ext/enumerable.rb

@@ -55,12 +55,12 @@ def maximum(key)
 
   # Calculates a sum from the elements.
   #
-  #  payments.sum { |p| p.price * p.tax_rate }
-  #  payments.sum(&:price)
+  #   payments.sum { |p| p.price * p.tax_rate }
+  #   payments.sum(&:price)
   #
   # The latter is a shortcut for:
   #
-  #  payments.inject(0) { |sum, p| sum + p.price }
+  #   payments.inject(0) { |sum, p| sum + p.price }
   #
   # It can also calculate the sum without the use of a block.
   #

activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb

@@ -5,10 +5,10 @@ class Hash
   # This includes the values from the root hash and from all
   # nested hashes and arrays.
   #
-  #  hash = { person: { name: 'Rob', age: '28' } }
+  #   hash = { person: { name: 'Rob', age: '28' } }
   #
-  #  hash.deep_transform_values{ |value| value.to_s.upcase }
-  #  # => {person: {name: "ROB", age: "28"}}
+  #   hash.deep_transform_values{ |value| value.to_s.upcase }
+  #   # => {person: {name: "ROB", age: "28"}}
   def deep_transform_values(&block)
     _deep_transform_values_in_object(self, &block)
   end

activesupport/lib/active_support/core_ext/hash/keys.rb

@@ -58,10 +58,10 @@ def assert_valid_keys(*valid_keys)
   # This includes the keys from the root hash and from all
   # nested hashes and arrays.
   #
-  #  hash = { person: { name: 'Rob', age: '28' } }
+  #   hash = { person: { name: 'Rob', age: '28' } }
   #
-  #  hash.deep_transform_keys{ |key| key.to_s.upcase }
-  #  # => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}
+  #   hash.deep_transform_keys{ |key| key.to_s.upcase }
+  #   # => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}
   def deep_transform_keys(&block)
     _deep_transform_keys_in_object(self, &block)
   end

activesupport/lib/active_support/core_ext/integer/inflections.rb

@@ -6,25 +6,25 @@ class Integer
   # Ordinalize turns a number into an ordinal string used to denote the
   # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
   #
-  #  1.ordinalize     # => "1st"
-  #  2.ordinalize     # => "2nd"
-  #  1002.ordinalize  # => "1002nd"
-  #  1003.ordinalize  # => "1003rd"
-  #  -11.ordinalize   # => "-11th"
-  #  -1001.ordinalize # => "-1001st"
+  #   1.ordinalize     # => "1st"
+  #   2.ordinalize     # => "2nd"
+  #   1002.ordinalize  # => "1002nd"
+  #   1003.ordinalize  # => "1003rd"
+  #   -11.ordinalize   # => "-11th"
+  #   -1001.ordinalize # => "-1001st"
   def ordinalize
     ActiveSupport::Inflector.ordinalize(self)
   end
 
   # Ordinal returns the suffix used to denote the position
   # in an ordered sequence such as 1st, 2nd, 3rd, 4th.
   #
-  #  1.ordinal     # => "st"
-  #  2.ordinal     # => "nd"
-  #  1002.ordinal  # => "nd"
-  #  1003.ordinal  # => "rd"
-  #  -11.ordinal   # => "th"
-  #  -1001.ordinal # => "st"
+  #   1.ordinal     # => "st"
+  #   2.ordinal     # => "nd"
+  #   1002.ordinal  # => "nd"
+  #   1003.ordinal  # => "rd"
+  #   -11.ordinal   # => "th"
+  #   -1001.ordinal # => "st"
   def ordinal
     ActiveSupport::Inflector.ordinal(self)
   end

activesupport/lib/active_support/core_ext/object/duplicable.rb

@@ -31,8 +31,8 @@ def duplicable?
 class Method
   # Methods are not duplicable:
   #
-  #  method(:puts).duplicable? # => false
-  #  method(:puts).dup         # => TypeError: allocator undefined for Method
+  #   method(:puts).duplicable? # => false
+  #   method(:puts).dup         # => TypeError: allocator undefined for Method
   def duplicable?
     false
   end
@@ -41,8 +41,8 @@ def duplicable?
 class UnboundMethod
   # Unbound methods are not duplicable:
   #
-  #  method(:puts).unbind.duplicable? # => false
-  #  method(:puts).unbind.dup         # => TypeError: allocator undefined for UnboundMethod
+  #   method(:puts).unbind.duplicable? # => false
+  #   method(:puts).unbind.dup         # => TypeError: allocator undefined for UnboundMethod
   def duplicable?
     false
   end
@@ -53,7 +53,7 @@ def duplicable?
 module Singleton
   # Singleton instances are not duplicable:
   #
-  # Class.new.include(Singleton).instance.dup # TypeError (can't dup instance of singleton
+  #   Class.new.include(Singleton).instance.dup # TypeError (can't dup instance of singleton
   def duplicable?
     false
   end

activesupport/lib/active_support/error_reporter.rb

@@ -127,12 +127,12 @@ def subscribe(subscriber)
 
     # Unregister an error subscriber. Accepts either a subscriber or a class.
     #
-    #  subscriber = MyErrorSubscriber.new
-    #  Rails.error.subscribe(subscriber)
+    #   subscriber = MyErrorSubscriber.new
+    #   Rails.error.subscribe(subscriber)
     #
-    #  Rails.error.unsubscribe(subscriber)
-    #  # or
-    #  Rails.error.unsubscribe(MyErrorSubscriber)
+    #   Rails.error.unsubscribe(subscriber)
+    #   # or
+    #   Rails.error.unsubscribe(MyErrorSubscriber)
     def unsubscribe(subscriber)
       @subscribers.delete_if { |s| subscriber === s }
     end

activesupport/lib/active_support/inflector/methods.rb

@@ -369,8 +369,8 @@ def const_regexp(camel_cased_word)
       # If passed an optional +locale+ parameter, the uncountables will be
       # found for that locale.
       #
-      #  apply_inflections('post', inflections.plurals, :en)    # => "posts"
-      #  apply_inflections('posts', inflections.singulars, :en) # => "post"
+      #   apply_inflections('post', inflections.plurals, :en)    # => "posts"
+      #   apply_inflections('posts', inflections.singulars, :en) # => "post"
       def apply_inflections(word, rules, locale = :en)
         result = word.to_s.dup
 

activesupport/lib/active_support/lazy_load_hooks.rb

@@ -66,7 +66,7 @@ def on_load(name, options = {}, &block)
     # Executes all blocks registered to +name+ via on_load, using +base+ as the
     # evaluation context.
     #
-    #  ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
+    #   ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
     #
     # In the case of the above example, it will execute all hooks registered
     # for +:active_record+ within the class +ActiveRecord::Base+.

activesupport/lib/active_support/notifications.rb

@@ -237,8 +237,8 @@ def instrument(name, payload = {})
       #
       # Raises an error if invalid event name type is passed:
       #
-      #  ActiveSupport::Notifications.subscribe(:render) {|*args| ...}
-      #  #=> ArgumentError (pattern must be specified as a String, Regexp or empty)
+      #   ActiveSupport::Notifications.subscribe(:render) {|*args| ...}
+      #   #=> ArgumentError (pattern must be specified as a String, Regexp or empty)
       #
       def subscribe(pattern = nil, callback = nil, &block)
         notifier.subscribe(pattern, callback, monotonic: false, &block)

activesupport/lib/active_support/number_helper.rb

@@ -358,13 +358,14 @@ def number_to_human_size(number, options = {})
     # out by default (set <tt>:strip_insignificant_zeros</tt> to
     # +false+ to change that):
     #
-    # number_to_human(12.00001)                                       # => "12"
-    # number_to_human(12.00001, strip_insignificant_zeros: false)     # => "12.0"
+    #   number_to_human(12.00001)                                       # => "12"
+    #   number_to_human(12.00001, strip_insignificant_zeros: false)     # => "12.0"
     #
     # ==== Custom Unit Quantifiers
     #
     # You can also use your own custom unit quantifiers:
-    #  number_to_human(500000, units: { unit: 'ml', thousand: 'lt' })  # => "500 lt"
+    #
+    #   number_to_human(500000, units: { unit: 'ml', thousand: 'lt' })  # => "500 lt"
     #
     # If in your I18n locale you have:
     #