Fix constant documents #12357
Merged
Fix constant documents #12357
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
nobu
added a commit
to nobu/rdoc
that referenced
this pull request
Dec 16, 2024
matzbot
pushed a commit
that referenced
this pull request
Dec 16, 2024
I think it is fixed now. |
Those directives are attached to `rb_define_const` and `rb_file_const` where we don’t need them because the functions are supported by RDoc.
|
Thanks @nobu. Dropped the commit for |
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.
This PR fixes two constant document issues:
RDoc doesn't generate docs for constants registered by
rb_define_global_constYou can find the docs for
ARGF,ARGV, ... are missing in Object docs.This is because
rb_define_global_constis not supported in RDoc. This PR addsDocument-constdirective.The generated docs have wired constant name duplication
Some constants defined in File::Constants has wired constant name duplication.
I don't know the detail of the RDoc documentation generation, but I found the constant definition function calls (
rb_file_constandrb_define_const) havingDocument-class:causes this issue. This PR drops the unnecessaryDocument-class:directives.