Project

General

Profile

Actions

Bug #20983

closed

New `Ruby` module is linked to from all kinds of documentation pages

Bug #20983: New `Ruby` module is linked to from all kinds of documentation pages

Added by Earlopain (Earlopain _) 10 months ago. Updated 10 months ago.

Status:
Closed
Assignee:
Target version:
-
[ruby-core:120410]

Description

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.

Updated by st0012 (Stan Lo) 10 months ago Actions #1 [ruby-core:120411]

I've reported this to the original issue too. I think the best solution is to enhance RDoc so not every module needs to be autolinked.

Updated by nobu (Nobuyoshi Nakada) 10 months ago Actions #2 [ruby-core:120426]

  • 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.

Updated by st0012 (Stan Lo) 10 months ago Actions #3 [ruby-core:120440]

  • Assignee set to rdoc

Updated by Earlopain (Earlopain _) 10 months ago 1Actions #5 [ruby-core:120470]

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

Updated by st0012 (Stan Lo) 10 months ago Actions #6

  • Status changed from Open to Closed
Actions

Also available in: PDF Atom