From 97d4363d3b4125d30120ab07cb69d3fc34b44bfc Mon Sep 17 00:00:00 2001 From: Peter Zhu Date: Fri, 16 Feb 2024 15:12:53 -0500 Subject: [PATCH] [DOC] Improve docs for GC.latest_compact_info --- gc.c | 22 +++++++++++++--------- 1 file 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.