ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
* [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
@ 2024-12-25 19:40 Earlopain (Earlopain _) via ruby-core
  2024-12-25 22:55 ` [ruby-core:120411] " st0012 (Stan Lo) via ruby-core
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: Earlopain (Earlopain _) via ruby-core @ 2024-12-25 19:40 UTC (permalink / raw)
  To: ruby-core; +Cc: Earlopain (Earlopain _)

Issue #20983 has been reported by Earlopain (Earlopain _).

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983

* Author: Earlopain (Earlopain _)
* Status: Open
* Backport: 3.1: UNKNOWN, 3.2: UNKNOWN, 3.3: UNKNOWN, 3.4: UNKNOWN
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

* [ruby-core:120411] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
  2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
@ 2024-12-25 22:55 ` st0012 (Stan Lo) via ruby-core
  2024-12-26 22:45 ` [ruby-core:120426] " nobu (Nobuyoshi Nakada) via ruby-core
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: st0012 (Stan Lo) via ruby-core @ 2024-12-25 22:55 UTC (permalink / raw)
  To: ruby-core; +Cc: st0012 (Stan Lo)

Issue #20983 has been updated by st0012 (Stan Lo).


I've reported this to the [original issue](https://bugs.ruby-lang.org/issues/20884#note-13) too. I think the best solution is to [enhance RDoc](https://github.com/ruby/rdoc/issues/1254) so not every module needs to be autolinked.

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983#change-111189

* Author: Earlopain (Earlopain _)
* Status: Open
* Backport: 3.1: UNKNOWN, 3.2: UNKNOWN, 3.3: UNKNOWN, 3.4: UNKNOWN
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

* [ruby-core:120426] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
  2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
  2024-12-25 22:55 ` [ruby-core:120411] " st0012 (Stan Lo) via ruby-core
@ 2024-12-26 22:45 ` nobu (Nobuyoshi Nakada) via ruby-core
  2024-12-28 17:53 ` [ruby-core:120440] " st0012 (Stan Lo) via ruby-core
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: nobu (Nobuyoshi Nakada) via ruby-core @ 2024-12-26 22:45 UTC (permalink / raw)
  To: ruby-core; +Cc: nobu (Nobuyoshi Nakada)

Issue #20983 has been updated by nobu (Nobuyoshi Nakada).

Backport changed from 3.1: UNKNOWN, 3.2: UNKNOWN, 3.3: UNKNOWN, 3.4: UNKNOWN to 3.1: DONTNEED, 3.2: DONTNEED, 3.3: DONTNEED, 3.4: DONTNEED

Yes, it is an essential weak point of WiKi word system.

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983#change-111205

* Author: Earlopain (Earlopain _)
* Status: Open
* Backport: 3.1: DONTNEED, 3.2: DONTNEED, 3.3: DONTNEED, 3.4: DONTNEED
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

* [ruby-core:120440] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
  2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
  2024-12-25 22:55 ` [ruby-core:120411] " st0012 (Stan Lo) via ruby-core
  2024-12-26 22:45 ` [ruby-core:120426] " nobu (Nobuyoshi Nakada) via ruby-core
@ 2024-12-28 17:53 ` st0012 (Stan Lo) via ruby-core
  2024-12-31 12:31 ` [ruby-core:120457] " st0012 (Stan Lo) via ruby-core
  2025-01-03 19:32 ` [ruby-core:120470] " Earlopain (Earlopain _) via ruby-core
  4 siblings, 0 replies; 6+ messages in thread
From: st0012 (Stan Lo) via ruby-core @ 2024-12-28 17:53 UTC (permalink / raw)
  To: ruby-core; +Cc: st0012 (Stan Lo)

Issue #20983 has been updated by st0012 (Stan Lo).

Assignee set to rdoc

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983#change-111217

* Author: Earlopain (Earlopain _)
* Status: Open
* Assignee: rdoc
* Backport: 3.1: DONTNEED, 3.2: DONTNEED, 3.3: DONTNEED, 3.4: DONTNEED
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

* [ruby-core:120457] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
  2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
                   ` (2 preceding siblings ...)
  2024-12-28 17:53 ` [ruby-core:120440] " st0012 (Stan Lo) via ruby-core
@ 2024-12-31 12:31 ` st0012 (Stan Lo) via ruby-core
  2025-01-03 19:32 ` [ruby-core:120470] " Earlopain (Earlopain _) via ruby-core
  4 siblings, 0 replies; 6+ messages in thread
From: st0012 (Stan Lo) via ruby-core @ 2024-12-31 12:31 UTC (permalink / raw)
  To: ruby-core; +Cc: st0012 (Stan Lo)

Issue #20983 has been updated by st0012 (Stan Lo).


https://github.com/ruby/ruby/pull/12491 should fix this issue.

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983#change-111238

* Author: Earlopain (Earlopain _)
* Status: Open
* Assignee: rdoc
* Backport: 3.1: DONTNEED, 3.2: DONTNEED, 3.3: DONTNEED, 3.4: DONTNEED
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

* [ruby-core:120470] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages
  2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
                   ` (3 preceding siblings ...)
  2024-12-31 12:31 ` [ruby-core:120457] " st0012 (Stan Lo) via ruby-core
@ 2025-01-03 19:32 ` Earlopain (Earlopain _) via ruby-core
  4 siblings, 0 replies; 6+ messages in thread
From: Earlopain (Earlopain _) via ruby-core @ 2025-01-03 19:32 UTC (permalink / raw)
  To: ruby-core; +Cc: Earlopain (Earlopain _)

Issue #20983 has been updated by Earlopain (Earlopain _).


Yes, it looks fine now. Thanks for working on it!

----------------------------------------
Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages
https://bugs.ruby-lang.org/issues/20983#change-111255

* Author: Earlopain (Earlopain _)
* Status: Open
* Assignee: rdoc
* Backport: 3.1: DONTNEED, 3.2: DONTNEED, 3.3: DONTNEED, 3.4: DONTNEED
----------------------------------------
For example https://docs.ruby-lang.org/en/master/index.html
* "Ruby" Documentation
* New to "Ruby"?
* "Ruby" interpreter
* Get invovled with the "Ruby" community
* Contribute to "Ruby"

Many other pages have a link to it as well, especially in headers it doesn't look very good.

The vast majority of cases will talk about Ruby the language, not Ruby the module. Is there maybe an option in rdoc to block autoreferences to a specific module? I think documentation will look much better without this link everywhere.



-- 
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/lists/ruby-core.ml.ruby-lang.org/

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

end of thread, other threads:[~2025-01-03 19:32 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-12-25 19:40 [ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages Earlopain (Earlopain _) via ruby-core
2024-12-25 22:55 ` [ruby-core:120411] " st0012 (Stan Lo) via ruby-core
2024-12-26 22:45 ` [ruby-core:120426] " nobu (Nobuyoshi Nakada) via ruby-core
2024-12-28 17:53 ` [ruby-core:120440] " st0012 (Stan Lo) via ruby-core
2024-12-31 12:31 ` [ruby-core:120457] " st0012 (Stan Lo) via ruby-core
2025-01-03 19:32 ` [ruby-core:120470] " Earlopain (Earlopain _) 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 NNTP newsgroup(s).