summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Zhu <[email protected]>2024-02-16 15:12:53 -0500
committerPeter Zhu <[email protected]>2024-02-20 17:39:46 -0500
commit97d4363d3b4125d30120ab07cb69d3fc34b44bfc (patch)
tree4816308f19eac03e08d7c47dd8f97396134e767b
parent35fdf1a6242906117da05ec66ae0e30827ab7199 (diff)
[DOC] Improve docs for GC.latest_compact_info
-rw-r--r--gc.c22
1 files changed, 13 insertions, 9 deletions
diff --git a/gc.c b/gc.c
index d279192427..4fc338015d 100644
--- a/gc.c
+++ b/gc.c
@@ -10897,16 +10897,20 @@ gc_update_references(rb_objspace_t *objspace)
*
* Returns information about object moved in the most recent \GC compaction.
*
- * The returned +hash+ has the following keys:
+ * The returned +hash+ contains the following keys:
*
- * - +:considered+: a hash containing the type of the object as the key and
- * the number of objects of that type that were considered for movement.
- * - +:moved+: a hash containing the type of the object as the key and the
- * number of objects of that type that were actually moved.
- * - +:moved_up+: a hash containing the type of the object as the key and the
- * number of objects of that type that were increased in size.
- * - +:moved_down+: a hash containing the type of the object as the key and
- * the number of objects of that type that were decreased in size.
+ * [considered]
+ * Hash containing the type of the object as the key and the number of
+ * objects of that type that were considered for movement.
+ * [moved]
+ * Hash containing the type of the object as the key and the number of
+ * objects of that type that were actually moved.
+ * [moved_up]
+ * Hash containing the type of the object as the key and the number of
+ * objects of that type that were increased in size.
+ * [moved_down]
+ * Hash containing the type of the object as the key and the number of
+ * objects of that type that were decreased in size.
*
* Some objects can't be moved (due to pinning) so these numbers can be used to
* calculate compaction efficiency.