Skip to content

[DOC] Tweaks for GC.stat #14211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2025
Merged

[DOC] Tweaks for GC.stat #14211

merged 2 commits into from
Aug 15, 2025

Conversation

BurdetteLamar
Copy link
Member

I have re-formatted, but not otherwise modified, the trailing list.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Aug 13, 2025
gc.rb Outdated
#
# The hash includes entries such as:
#
# - +count:+ -
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there a dash after each of the keys? It generates as a dash in the rendered HTML:

Screenshot 2025-08-13 at 3 30 01 PM

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had +foo:+:, but it looked weird to have the two colons; so I used +foo:+ - instead. I think we have done this a couple of other places, for similar reasons.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it's a symbol, we can (and probably should) put the colon at the beginning, like this:

  # - +:count+:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duh. What was I thinking? Will fix.

@peterzhu2118 peterzhu2118 merged commit 12e42f7 into ruby:master Aug 15, 2025
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants