# RDoc: How to link to a method description from other rdoc page?

**URL:** <https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834>\
**Category:** Ruby\
**Created:** [July 28, 2009, 7:01pm UTC](https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834 "2009-07-28T19:01:42Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [July 28, 2009, 7:01pm UTC](https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834/1 "2009-07-28T19:01:42Z")

</div>

Hi, RDoc documentation says:

“Names of classes, source files, and any method names containing an  
underscore or preceded by a hash character are automatically  
hyperlinked from comment text to their description.”

However, how to link to a method definition from a README.rdoc file?  
I’ve tryed everything:

MyModule::MyClass#get  
[MyModule::MyClass#get]  
[link:MyModule::MyClass#get]

but nothing works ☹

Any tip please? Thanks a lot.

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [July 28, 2009, 7:11pm UTC](https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834/2 "2009-07-28T19:11:40Z")

</div>

2009/7/28 Iñaki Baz C. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid):

> Â [MyModule::MyClass#get]  
> Â [link:MyModule::MyClass#get]

Ok, it works.

However, there must be some issue with my RDoc output since I have a  
module “MyModule” with a class “MyClass”. And methods of the class are  
displayed as “MyModule#method” instead of  
“MyModule::MyClass#method”…

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [July 28, 2009, 7:59pm UTC](https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834/3 "2009-07-28T19:59:41Z")

</div>

Why links to classes or methods documentation cannot be hidden with  
label?

The following:

Google[[http://google.es](http://google.es)]

is displayed as:

Google

But the following:

get[MyModule::Client#get]

is displayed as:

get[MyModule::Client#get]

Perhaps other bug?

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [July 28, 2009, 11:04pm UTC](https://www.ruby-forum.com/t/rdoc-how-to-link-to-a-method-description-from-other-rdoc-page/172834/4 "2009-07-28T23:04:39Z")

</div>

On Jul 28, 2009, at 10:59, Iñaki Baz C. wrote:

> Google
> 
> Perhaps other bug?

Perhaps.