[DOC] Tweaks for GC.config #14137
Merged
[DOC] Tweaks for GC.config #14137
+37
−49
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peterzhu2118
reviewed
Aug 7, 2025
gc.rb
Outdated
Comment on lines
255
to
256
| # This method is expected to be defined, useful, and well-behaved | ||
| # only in the CRuby implementation. |
There was a problem hiding this comment.
I think this is too wordy. Maybe something like "This method is implementation-specific to CRuby" is better?
Comment on lines
-257
to
-258
| # Configuration parameters are \GC implementation-specific and may change | ||
| # without notice. |
There was a problem hiding this comment.
We should keep this. Ruby now allows alternate GC implementation, and the parameters specified here may not apply to a different implementation.
gc.rb
Outdated
| # | ||
| # When +false+, Young to Old object promotion is disabled. For performance | ||
| # reasons, it is recommended to warm up an application using +Process.warmup+ | ||
| # Setting this parameter to +false+ disables young-to-old promotion . |
There was a problem hiding this comment.
Nit: space before period
Suggested change
| # Setting this parameter to +false+ disables young-to-old promotion . | |
| # Setting this parameter to +false+ disables young-to-old promotion. |
Comment on lines
-308
to
-310
| # A flag will be set to notify that a full mark has been | ||
| # requested. This flag is accessible using | ||
| # <code>GC.latest_gc_info(:need_major_by)</code> |
There was a problem hiding this comment.
This is useful information we should keep.
There was a problem hiding this comment.
Restored (with slight reorganization).
peterzhu2118
approved these changes
Aug 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.