Issue #4665 has been updated by Loren Segal.


I noticed that Set#do_with_enum is already marked as private-- most likely so that it does not show up in documentation (at least using the default rdoc arguments). Therefore, is :nodoc: really necessary here? I point to http://ruby-doc.org/stdlib/libdoc/set/rdoc/classes/Set.html which seems to ignore private methods, including #do_with_enum.

As far as Set#flatten_merge goes-- perhaps instead of marking it as :nodoc: it should be made private. This way it will also be ignored from docs.

That said-- perhaps the list of undocumented items should be updated to exclude private methods, which are currently already excluded from docs. If not, perhaps :nodoc: isn't the right answer and real docs should be added, since :nodoc: doesn't actually add any documentation here, so the change in doc coverage would just be superficial. Does anyone object to having docs for there internal methods? I wouldn't mind writing something.  





----------------------------------------
Bug #4665: Add nodoc comments for Set methods
http://redmine.ruby-lang.org/issues/4665

Author: Pete Higgins
Status: Open
Priority: Low
Assignee: Eric Hodel
Category: DOC
Target version: 
ruby -v: 1.9.2-p180


Set#flatten_merge and Set#do_with_enum are called internally by other Set methods. Add nodoc comments to them so they don't show up in the list of undocumented things.


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