[ruby-core:120410] [Ruby master Bug#20983] New `Ruby` module is linked to from all kinds of documentation pages

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/

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/

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/

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/

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/

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/
participants (3)
-
Earlopain (Earlopain _)
-
nobu (Nobuyoshi Nakada)
-
st0012 (Stan Lo)