[DOC] documents of aliased methods

ruby · Dec 18, 2023 · 9abaf00 · 9abaf00
1 parent ba1d152
commit 9abaf00
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/gc.rb b/gc.rb
@@ -39,6 +39,7 @@ def self.start full_mark: true, immediate_mark: true, immediate_sweep: true
     Primitive.gc_start_internal full_mark, immediate_mark, immediate_sweep, false
   end
 
+  # Alias of GC.start
   def garbage_collect full_mark: true, immediate_mark: true, immediate_sweep: true
     Primitive.gc_start_internal full_mark, immediate_mark, immediate_sweep, false
   end
@@ -322,6 +323,7 @@ def self.total_time
 end
 
 module ObjectSpace
+  # Alias of GC.start
   def garbage_collect full_mark: true, immediate_mark: true, immediate_sweep: true
     Primitive.gc_start_internal full_mark, immediate_mark, immediate_sweep, false
   end