ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
* [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword
@ 2023-10-08  0:15 zzak (Zak Scott) via ruby-core
  2023-10-08  1:36 ` [ruby-core:114973] " austin (Austin Ziegler) via ruby-core
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: zzak (Zak Scott) via ruby-core @ 2023-10-08  0:15 UTC (permalink / raw
  To: ruby-core; +Cc: zzak (Zak Scott)

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
* https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [ruby-core:114973] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword
  2023-10-08  0:15 [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword zzak (Zak Scott) via ruby-core
@ 2023-10-08  1:36 ` austin (Austin Ziegler) via ruby-core
  2023-10-08  2:03 ` [ruby-core:114974] " nobu (Nobuyoshi Nakada) via ruby-core
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: austin (Austin Ziegler) via ruby-core @ 2023-10-08  1:36 UTC (permalink / raw
  To: ruby-core; +Cc: austin (Austin Ziegler)

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
> * https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
* https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [ruby-core:114974] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword
  2023-10-08  0:15 [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword zzak (Zak Scott) via ruby-core
  2023-10-08  1:36 ` [ruby-core:114973] " austin (Austin Ziegler) via ruby-core
@ 2023-10-08  2:03 ` nobu (Nobuyoshi Nakada) via ruby-core
  2023-10-08  2:18 ` [ruby-core:114975] " nobu (Nobuyoshi Nakada) via ruby-core
  2023-10-08  2:25 ` [ruby-core:114976] " nobu (Nobuyoshi Nakada) via ruby-core
  3 siblings, 0 replies; 5+ messages in thread
From: nobu (Nobuyoshi Nakada) via ruby-core @ 2023-10-08  2:03 UTC (permalink / raw
  To: ruby-core; +Cc: nobu (Nobuyoshi Nakada)

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
* https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [ruby-core:114975] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword
  2023-10-08  0:15 [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword zzak (Zak Scott) via ruby-core
  2023-10-08  1:36 ` [ruby-core:114973] " austin (Austin Ziegler) via ruby-core
  2023-10-08  2:03 ` [ruby-core:114974] " nobu (Nobuyoshi Nakada) via ruby-core
@ 2023-10-08  2:18 ` nobu (Nobuyoshi Nakada) via ruby-core
  2023-10-08  2:25 ` [ruby-core:114976] " nobu (Nobuyoshi Nakada) via ruby-core
  3 siblings, 0 replies; 5+ messages in thread
From: nobu (Nobuyoshi Nakada) via ruby-core @ 2023-10-08  2:18 UTC (permalink / raw
  To: ruby-core; +Cc: nobu (Nobuyoshi Nakada)

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
* https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [ruby-core:114976] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword
  2023-10-08  0:15 [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword zzak (Zak Scott) via ruby-core
                   ` (2 preceding siblings ...)
  2023-10-08  2:18 ` [ruby-core:114975] " nobu (Nobuyoshi Nakada) via ruby-core
@ 2023-10-08  2:25 ` nobu (Nobuyoshi Nakada) via ruby-core
  3 siblings, 0 replies; 5+ messages in thread
From: nobu (Nobuyoshi Nakada) via ruby-core @ 2023-10-08  2:25 UTC (permalink / raw
  To: ruby-core; +Cc: nobu (Nobuyoshi Nakada)

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/c8b3642eded5a25ee5cc11c48395bed05f92424e
* https://github.com/rails/rails/commit/4726b1ab4780a8d8033130165eb1628286935dcb



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2023-10-08  2:25 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-10-08  0:15 [ruby-core:114972] [Ruby master Bug#19914] RDoc :method: directives swallowed by immediate private keyword zzak (Zak Scott) via ruby-core
2023-10-08  1:36 ` [ruby-core:114973] " austin (Austin Ziegler) via ruby-core
2023-10-08  2:03 ` [ruby-core:114974] " nobu (Nobuyoshi Nakada) via ruby-core
2023-10-08  2:18 ` [ruby-core:114975] " nobu (Nobuyoshi Nakada) via ruby-core
2023-10-08  2:25 ` [ruby-core:114976] " nobu (Nobuyoshi Nakada) via ruby-core

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).