[ruby-core:45944] [ruby-trunk - Bug #6666][Open] Documentation Improve - rdoc does not know where rb_obj_methods is (#methods)

Issue #6666 has been reported by shevegen (markus heiler).

----------------------------------------
Bug #6666: Documentation Improve - rdoc does not know where rb_obj_methods is (#methods)
https://bugs.ruby-lang.org/issues/6666

Author: shevegen (markus heiler)
Status: Open
Priority: Low
Assignee: 
Category: 
Target version: 1.9.3
ruby -v: ruby 1.9.3p194


Hi.

It seems there is no simple online documentation available what
#methods is doing in Ruby:

<davidcelis> can't find #methods anywhere in the docs
<tds> really strange
<tds> the docs are normally quite thorough

Upon looking at this, we saw the method defined first in
object.c here:

object.c:    rb_define_method(rb_mKernel, "methods", rb_obj_methods, -1);

https://github.com/ruby/ruby/blob/trunk/object.c#L2897

Referring to:

class.c:    rb_obj_methods(int argc, VALUE *argv, VALUE obj)

class.c has the proper rdoc documentation for #methods there.
But this does not seem to show up in the online docu.

On IRC, Mon_Ouie said that a reference is missing in order
to make this work:

<shevy> class.c has the rdoc docu though
<Mon_Ouie> All that's missing is the /* in class.c */ comment
<Mon_Ouie> to make rdoc find the method
<Mon_Ouie> Yeah, the method is documented, but RDoc doesn't know in what file it is defined, since it's not object.c
<Mon_Ouie> So it needs a /* in class.c */ comment to know where to look for it

My request:

Could class.c include this comment so that the online documentation will point
to the proper #methods documentation?


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