Misc #16443: GC.compact is not documented

• Status: Closed
• Assignee: tenderlovemaking (Aaron Patterson)

[zverok (Victor Shepelev)]

See https://docs.ruby-lang.org/en/master/GC.html#method-c-compact

Typically, I'd just submit a documentation PR, but I am not sure I can properly explain what it does and when it should be used.

[zverok (Victor Shepelev)]

@tenderlovemaking (Aaron Patterson)? @ko1 (Koichi Sasada)? Anybody? It is still this way a week before 3.0?

Can somebody at least provide some draft explanations, or should I dig the sources more?..

[tenderlovemaking (Aaron Patterson)]

Hi Victor. I added some documentation in 895b10ad020a788566c6e35431d07e6121e38c87. Please feel free to add more details, but I don't want to describe how the internals work since they may change.

Thanks.

[tenderlovemaking (Aaron Patterson)]

• Status changed from Open to Closed

Applied in changeset [ruby-core:96395]" href="/projects/ruby-master/repository/git/revisions/895b10ad020a788566c6e35431d07e6121e38c87">git|895b10ad020a788566c6e35431d07e6121e38c87.

---

Add documentation about GC.compact

[Misc #16443][ruby-core:96395]

[zverok (Victor Shepelev)]

@tenderlovemaking (Aaron Patterson) thanks a lot!