Project

General

Profile

Actions

Misc #16443

closed

GC.compact is not documented

Added by zverok (Victor Shepelev) almost 2 years ago. Updated 10 months ago.

Status:
Closed
Priority:
Normal
[ruby-core:96395]

Description

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.

Updated by zverok (Victor Shepelev) 10 months ago

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?..

Updated by tenderlovemaking (Aaron Patterson) 10 months ago

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.

Actions #3

Updated by tenderlovemaking (Aaron Patterson) 10 months ago

  • Status changed from Open to Closed

Applied in changeset git|895b10ad020a788566c6e35431d07e6121e38c87.


Add documentation about GC.compact

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

Actions

Also available in: Atom PDF