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

Issue #6381 has been updated by jamesbritt (James Britt).


I think there is some misunderstanding here.

Ruby API docs on ruby-doc.org are generated using 

     rdoc --op <some_place> -f <some_template> prelude.rb *.c

The '--all' flag is not used.  Therefore, methods marked as private are not shown.  For the most part this is fine (if one agrees that people looking up docs should not be using private methods).  The problem is that there are some methods that are marked private but their use case is more akin to public because of the context in which they are used.  For example,  `Module#attr_accessor`.

Currently, in order to get the docs for `attr_accessor` to appear the rdocs need to be generated using the  `--all` flag.  This works, but also exposes every other private method (excluding anything marked with :nodoc:)



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

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/