Bug #19914: RDoc :method: directives swallowed by immediate private keyword

• Status: Feedback
• Assignee: -
• Target version: -
• Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN

[zzak (zzak _)]

@jonathanhefner Recently discovered this bug in RDoc and fixed it in Rails, so I'm reporting it here on their behalf.

Examples:

• https://github.com/rails/rails/commit/c8b3642eded5a25ee5cc11c48395bed05f92424e
• https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb

[austin (Austin Ziegler)]

zzak (zzak _) wrote:

@jonathanhefner Recently discovered this bug in RDoc and fixed it in Rails, so I'm reporting it here on their behalf.

Examples:

• https://github.com/rails/rails/commit/c8b3642eded5a25ee5cc11c48395bed05f92424e
• https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb

This should probably be reported to https://github.com/ruby/rdoc/issues instead.

[nobu (Nobuyoshi Nakada)]

With a simplified example like bellow, private does not affect the results.

class Bug19914
  ##
  # :method: foo
  #
  # :call-seq: foo(*args)
  #
  # Foo

  private
end

[nobu (Nobuyoshi Nakada)]

It appears that the next method takes precedence over the :method: directive.
And that directive seems like parsed as a simple document.

[nobu (Nobuyoshi Nakada)]

• Status changed from Open to Feedback

It has been documented.

https://github.com/ruby/rdoc/blob/master/lib/rdoc/parser/ruby.rb#L141-L142

Note that by default, the :method: directive will be ignored if there is a
standard rdocable item following it.