From 31e8a9fced895845a7aac123080d325768177b19 Mon Sep 17 00:00:00 2001
From: BurdetteLamar <burdettelamar@yahoo.com>
Date: Tue, 12 Aug 2025 13:40:39 -0500
Subject: [PATCH] [DOC] Tweaks for GC.latest_gc_info

---
 gc.rb | 48 ++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 38 insertions(+), 10 deletions(-)

diff --git a/gc.rb b/gc.rb
index 2972343e2a..1d45b48b34 100644
--- a/gc.rb
+++ b/gc.rb
@@ -324,19 +324,47 @@ module GC
   end
 
   # call-seq:
-  #     GC.latest_gc_info -> hash
-  #     GC.latest_gc_info(hash) -> hash
-  #     GC.latest_gc_info(key) -> value
+  #   GC.latest_gc_info -> new_hash
+  #   GC.latest_gc_info(key) -> value
+  #   GC.latest_gc_info(hash) -> hash
   #
-  # Returns information about the most recent garbage collection.
+  # With no argument given,
+  # returns information about the most recent garbage collection:
   #
-  # If the argument +hash+ is given and is a Hash object,
-  # it is overwritten and returned.
-  # This is intended to avoid the probe effect.
+  #   GC.latest_gc_info
+  #   # =>
+  #   {major_by: :force,
+  #    need_major_by: nil,
+  #    gc_by: :method,
+  #    have_finalizer: false,
+  #    immediate_sweep: true,
+  #    state: :none,
+  #    weak_references_count: 0,
+  #    retained_weak_references_count: 0}
+  #
+  # With symbol argument +key+ given,
+  # returns the value for that key:
+  #
+  #   GC.latest_gc_info(:gc_by) # => :newobj
+  #
+  # With hash argument +hash+ given,
+  # returns that hash with GC information merged into its content;
+  # this form may be useful in minimizing {probe effects}[https://en.wikipedia.org/wiki/Probe_effect]:
+  #
+  #   h = {foo: 0, bar: 1}
+  #   GC.latest_gc_info(h)
+  #   # =>
+  #   {foo: 0,
+  #    bar: 1,
+  #    major_by: nil,
+  #    need_major_by: nil,
+  #    gc_by: :newobj,
+  #    have_finalizer: false,
+  #    immediate_sweep: false,
+  #    state: :sweeping,
+  #    weak_references_count: 0,
+  #    retained_weak_references_count: 0}
   #
-  # If the argument +key+ is given and is a Symbol object,
-  # it returns the value associated with the key.
-  # This is equivalent to <tt>GC.latest_gc_info[key]</tt>.
   def self.latest_gc_info hash_or_key = nil
     if hash_or_key == nil
       hash_or_key = {}