[DOC] Improve some GC docs

peterzhu2118 · peterzhu2118 · commit 300bc1458924 · 2023-08-15T08:54:27.000-04:00
diff --git a/gc.c b/gc.c
@@ -13813,7 +13813,7 @@ Init_GC(void)
         rb_hash_aset(gc_constants, ID2SYM(rb_intern("RB_BUG_INSTEAD_OF_RB_MEMERROR")), Qtrue);
     }
     OBJ_FREEZE(gc_constants);
-    /* internal constants */
+    /* Internal constants in the garbage collector. */
     rb_define_const(rb_mGC, "INTERNAL_CONSTANTS", gc_constants);
 
     rb_mProfiler = rb_define_module_under(rb_mGC, "Profiler");
diff --git a/gc.rb b/gc.rb
@@ -1,6 +1,6 @@
 # for gc.c
 
-#  The GC module provides an interface to Ruby's mark and
+#  The \GC module provides an interface to Ruby's mark and
 #  sweep garbage collection mechanism.
 #
 #  Some of the underlying methods are also available via the ObjectSpace

Original file line number	Diff line number	Diff line change
`@@ -13813,7 +13813,7 @@ Init_GC(void)`
`13813`	`13813`	`rb_hash_aset(gc_constants, ID2SYM(rb_intern("RB_BUG_INSTEAD_OF_RB_MEMERROR")), Qtrue);`
`13814`	`13814`	`}`
`13815`	`13815`	`OBJ_FREEZE(gc_constants);`
`13816`		`- /* internal constants */`
	`13816`	`+ /* Internal constants in the garbage collector. */`
`13817`	`13817`	`rb_define_const(rb_mGC, "INTERNAL_CONSTANTS", gc_constants);`
`13818`	`13818`
`13819`	`13819`	`rb_mProfiler = rb_define_module_under(rb_mGC, "Profiler");`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# for gc.c`
`2`	`2`
`3`		`-# The GC module provides an interface to Ruby's mark and`
	`3`	`+# The \GC module provides an interface to Ruby's mark and`
`4`	`4`	`# sweep garbage collection mechanism.`
`5`	`5`	`#`
`6`	`6`	`# Some of the underlying methods are also available via the ObjectSpace`