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

Issue #6381 has been updated by drbrain (Eric Hodel).


=begin
For documentation in ruby, (({:nodoc:})) is used to indicate implementation details and (({private})) is used for access control.

While not all of the standard library hides its implementation details using (({:nodoc:})), the core C-implemented classes do.  It would be helpful if ruby-doc.org started moving towards adding ((%--all%)) when building documentation.
=end

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

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/