[ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword

Issue #19914 has been reported by zzak (Zak Scott). ---------------------------------------- Bug #19914: RDoc :method: directives swallowed by immediate private keyword https://bugs.ruby-lang.org/issues/19914 * Author: zzak (Zak Scott) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- @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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d... -- https://bugs.ruby-lang.org/

Issue #19914 has been updated by 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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d...
This should probably be reported to https://github.com/ruby/rdoc/issues instead. ---------------------------------------- Bug #19914: RDoc :method: directives swallowed by immediate private keyword https://bugs.ruby-lang.org/issues/19914#change-104845 * Author: zzak (zzak _) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- @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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d... -- https://bugs.ruby-lang.org/

Issue #19914 has been updated by nobu (Nobuyoshi Nakada). With a simplified example like bellow, `private` does not affect the results. ```ruby class Bug19914 ## # :method: foo # # :call-seq: foo(*args) # # Foo private end ``` ---------------------------------------- Bug #19914: RDoc :method: directives swallowed by immediate private keyword https://bugs.ruby-lang.org/issues/19914#change-104846 * Author: zzak (zzak _) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- @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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d... -- https://bugs.ruby-lang.org/

Issue #19914 has been updated by 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. ---------------------------------------- Bug #19914: RDoc :method: directives swallowed by immediate private keyword https://bugs.ruby-lang.org/issues/19914#change-104847 * Author: zzak (zzak _) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- @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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d... -- https://bugs.ruby-lang.org/

Issue #19914 has been updated by 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.
---------------------------------------- Bug #19914: RDoc :method: directives swallowed by immediate private keyword https://bugs.ruby-lang.org/issues/19914#change-104848 * Author: zzak (zzak _) * Status: Feedback * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- @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/c8b3642eded5a25ee5cc11c48395bed05f9242... * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935d... -- https://bugs.ruby-lang.org/
participants (3)
-
austin (Austin Ziegler)
-
nobu (Nobuyoshi Nakada)
-
zzak (Zak Scott)