[ruby-core:45171] [ruby-trunk - Bug #6381] Useful methods like included don't appear in RDoc

Issue #6381 has been updated by trans (Thomas Sawyer).


Actually, I can't understand why anyone would want to hide private methods. As long as they are clearly marked private in the documentation, then there is no confusion and it is to the advantage of the developer, in that he is able to fully follow the execution of a method and thus truly know what it does. Without private methods being documented you can't do this without pulling up original source code.

----------------------------------------
Bug #6381: Useful methods like included don't appear in RDoc
https://bugs.ruby-lang.org/issues/6381#change-26751

Author: agrimm (Andrew Grimm)
Status: Third Party's Issue
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: 
Target version: 
ruby -v: ruby 1.9.1p378 (2010-01-10 revision 26273) [i386-mingw32]


=begin
Methods like (({Module.included})) and (({Module.private_constant})) don't appear in ruby-doc.org's documentation, because they are private methods. This can cause difficulty for new users of Ruby, for example in http://stackoverflow.com/q/10369876/38765

While there is a rationale behind not showing some private methods, because they are implementation details that should not be relied upon by users of Ruby, this isn't the case here.

This issue has been discussed in ruby-core:40662 and elsewhere, but is something that needs to be put in a bug tracker.
=end



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