Skip to content

Commit

Permalink
[DOC] Improve docs for GC.compact
Browse files Browse the repository at this point in the history
  • Loading branch information
peterzhu2118 committed Jan 15, 2024
1 parent 5e61cc2 commit cc7b19e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions gc.c
Expand Up @@ -11108,16 +11108,16 @@ heap_check_moved_i(void *vstart, void *vend, size_t stride, void *data)

/*
* call-seq:
* GC.compact
* GC.compact -> hash
*
* This function compacts objects together in Ruby's heap. It eliminates
* 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 <tt>GC.latest_compact_info</tt> for details
* about compaction statistics.
* unused space.
*
* This method is implementation specific and not expected to be implemented
* in any implementation besides MRI.
* The returned +hash+ contains statistics about the objects that were moved;
* see GC.latest_compact_info.
*
* This method is only expected to work on CRuby.
*
* To test whether \GC compaction is supported, use the idiom:
*
Expand Down

0 comments on commit cc7b19e

Please sign in to comment.