From: Marc-Andre Lafortune <redmine@...>
Date: 2010-03-27T06:08:59+09:00
Subject: [ruby-core:29053] [Feature #3023] RDoc urls

Feature #3023: RDoc urls
http://redmine.ruby-lang.org/issues/show/3023

Author: Marc-Andre Lafortune
Status: Open, Priority: Normal
Assigned to: Eric Hodel, Category: doc

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.


----------------------------------------
http://redmine.ruby-lang.org