Fix C extension docs in ruby/ruby#3927
Merged
Merged
Conversation
Because ruby/ruby doesn't use our rake task it also uses the default markup (rdoc), unless specified otherwise. github.com/ruby/pull/3572 already added it explicitly to ruby files. For C however, it is not so easy because of a rdoc bug: ruby/rdoc#1597 Adding the comment would remove all documentation since it gets parsed as ruby. So, specify it for each method individually. Remove it from the template since there is only one C file relevant for rdoc.
Collaborator
|
Honestly instead of doing this I'd be more keen to just use actual rdoc syntax |
Collaborator
Author
|
Rdoc will switch the default to markdown in the future https://github.com/ruby/rdoc/?tab=readme-ov-file#markup-formats No clue when that actually happens but in the future we can just remove all these comments (and in ruby files too) |
kddnewton
approved these changes
Feb 16, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Because ruby/ruby doesn't use our rake task it also uses the default markup (rdoc), unless specified otherwise. #3572 already added it explicitly to ruby files.
For C however, it is not so easy because of a rdoc bug: ruby/rdoc#1597 Adding the comment would remove all documentation since it gets parsed as ruby.
So, specify it for each method individually. Remove it from the template since there is only one C file relevant for rdoc. Fixes this:
which is hopefully the last issue. I diffed the docs in ruby/prism and this creates no difference here.