Merge pull request #33147 from nsgc/add-api-document-about-migration-methods

Add docs for ActiveRecord::Migration#say, #say_with_time, #suppress_messages [ci skip]

1 files changed, 5 insertions, 0 deletions

diff --git a/activerecord/lib/active_record/migration.rb b/activerecord/lib/active_record/migration.rb
index 025201c20b..6ace973c29 100644
--- a/activerecord/lib/active_record/migration.rb
+++ b/activerecord/lib/active_record/migration.rb
@@ -831,10 +831,14 @@ module ActiveRecord
       write "== %s %s" % [text, "=" * length]
     end
 
+    # Takes a message argument and outputs it as is.
+    # A second boolean argument can be passed to specify whether to indent or not.
     def say(message, subitem = false)
       write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
+    # Outputs text along with how long it took to run its block.
+    # If the block returns an integer it assumes it is the number of rows affected.
     def say_with_time(message)
       say(message)
       result = nil
@@ -844,6 +848,7 @@ module ActiveRecord
       result
     end
 
+    # Takes a block as an argument and suppresses any output generated by the block.
     def suppress_messages
       save, self.verbose = verbose, false
       yield