Feature #3023

RDoc urls

Added by marcandre (Marc-Andre Lafortune) over 10 years ago. Updated about 9 years ago.

Target version:


Currently, rdoc generates url for methods that look like:


This has two drawbacks.

1) This URL is subject to change when methods are added/removed. This makes it impossible to reference the documentation of a method.

2) There is no way to know what method this refers to just by looking at it.

If instead the url looked like:


then it would be human readable and RESTful.

The method name simply need to be URI encoded and suffixed with either instance_method, class_method, or -constant.


rdoc_url.patch (4.5 KB) rdoc_url.patch marcandre (Marc-Andre Lafortune), 04/19/2010 09:41 AM

Updated by drbrain (Eric Hodel) over 10 years ago

  • Category changed from doc to lib
  • Priority changed from Normal to 3

I have been meaning to implement this feature in RDoc, but I have been focused on cleanup. Hopefully soon!


Updated by mame (Yusuke Endoh) over 10 years ago

  • Category set to lib
  • Target version set to 1.9.2


This ticket is accepted by Eric Hodel, so I set the target to 1.9.2.

It will be deferred to 1.9.x if the commit is late for implementation
freezing (30 Apr.).

Yusuke Endoh


Updated by znz (Kazuhiro NISHIYAMA) over 10 years ago

  • Status changed from Open to Assigned




Updated by marcandre (Marc-Andre Lafortune) about 10 years ago

I've attached a patch for this.

Note that the test_rdoc_markup_to_html_crossref makes the issue #3169 I just posted quite obvious. I changed the test only to fit the new naming scheme, and marked the wrong assertions accordingly.


Updated by drbrain (Eric Hodel) about 10 years ago

Implemented in RDoc trunk.


Updated by drbrain (Eric Hodel) about 10 years ago

  • Status changed from Assigned to Closed



Also available in: Atom PDF