Project

General

Profile

Feature #3023

RDoc urls

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

Status:
Closed
Priority:
Normal
Target version:
[ruby-core:29053]

Description

=begin
Currently, rdoc generates url for methods that look like:

.../classes/Enumerable.html#M002713

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:

.../classes/Enumerable.html#map-instance_method

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.
=end


Files

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

History

#1

Updated by drbrain (Eric Hodel) over 9 years ago

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

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

#2

Updated by mame (Yusuke Endoh) over 9 years ago

  • Category set to lib
  • Target version set to 1.9.2

=begin
Hi,

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 mame@tsg.ne.jp
=end

#3

Updated by znz (Kazuhiro NISHIYAMA) over 9 years ago

  • Status changed from Open to Assigned

=begin

=end

#4

Updated by marcandre (Marc-Andre Lafortune) over 9 years ago

=begin
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.
=end

#5

Updated by drbrain (Eric Hodel) over 9 years ago

=begin
Implemented in RDoc trunk.
=end

#6

Updated by drbrain (Eric Hodel) over 9 years ago

  • Status changed from Assigned to Closed

=begin

=end

Also available in: Atom PDF