Add documentation about GC.compact

[Misc #16443][ruby-core:96395]

1 files changed, 11 insertions, 0 deletions

diff --git a/gc.rb b/gc.rb
index 4e0faaf00d..8a00b406ce 100644
--- a/gc.rb
+++ b/gc.rb
@@ -198,6 +198,17 @@ module GC
     Primitive.gc_compact_stats
   end
 
+  #  call-seq:
+  #     GC.compact
+  #
+  # This function compacts objects together in Ruby's heap.  It eliminates
+  # unused space (or fragmentation) in the heap by moving objects in to that
+  # unused space.  This function returns a hash which contains statistics about
+  # which objects were moved.  See `GC.latest_gc_info` for details about
+  # compaction statistics.
+  #
+  # This method is implementation specific and not expected to be implemented
+  # in any implementation besides MRI.
   def self.compact
     Primitive.gc_compact
   end