Add example of :method: directive getting ignored.#1588
Open
p8 wants to merge 1 commit intoruby:masterfrom
Open
Add example of :method: directive getting ignored.#1588p8 wants to merge 1 commit intoruby:masterfrom
p8 wants to merge 1 commit intoruby:masterfrom
Conversation
Also make the comment about hidden methods slightly clearer — these methods don't appear in the code, but they appear in the generated documentation.
p8
requested a deployment
to
fork-preview-protection
GitHub Actions
Waiting
tompng
reviewed
Feb 5, 2026
| # You can provide documentation for methods that don't appear using | ||
| # the :method:, :singleton-method: and :attr: directives: | ||
| # You can provide documentation for methods that don't appear in the code | ||
| # using the :method:, :singleton-method: and :attr: directives: |
| # # :method: ghost_method | ||
| # # ghost_method will be ignored. | ||
| # | ||
| # def standard_rdocable_method() end |
Member
There was a problem hiding this comment.
This part seems it's just describing a bug or unintentional behavior in detail.
In this example, HTML contains ":method: ghost_method" as a plain text. Looks like a bug.
##
# :method: ghost_method
# ghost_method will be ignored.
def standard_rdocable_method() end # rdocable itemIn this example, :method: directive is ignored, nothing is documented. I also think this is a bug too.
##
# :method: foobarbaz_foo
attr_reader("#{PREFIX}_foo") # RDoc::Parser::Ruby thinks this is an rdocable itemIn both cases, result will changed in the experimental (and the next default) RDoc::Parser::PrismRuby parser.
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.
Also make the comment about hidden methods slightly clearer — these
methods don't appear in the code, but they appear in the generated
documentation.