Skip to content

Add example of :method: directive getting ignored. #1588

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.

Sign up for GitHub

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

Open
p8 wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −4
Open

Add example of :method: directive getting ignored. #1588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions lib/rdoc/parser/ruby.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@
#
# == Hidden methods and attributes
#
# 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:
#
# ##
# # :attr_writer: ghost_writer
Expand All @@ -148,8 +148,13 @@
# def regular_method() end
#
# Note that by default, the :method: directive will be ignored if there is a
# standard rdocable item following it.

# standard rdocable item following it:
#
# ##
# # :method: ghost_method
# # ghost_method will be ignored.
#
# def standard_rdocable_method() end
class RDoc::Parser::Ruby < RDoc::Parser

parse_files_matching(/\.rbw?$/)
Expand Down