From: Pete Higgins <pete@...>
Date: 2011-05-12T07:44:06+09:00
Subject: [ruby-core:36114] [Ruby 1.9 - Bug #4665] Add nodoc comments for Set methods


Issue #4665 has been updated by Pete Higgins.


Hi Loren,

Rdoc excluding private methods in its output but considering them undocumented sounds like an issue with rdoc. I'll take that up with Eric.

Set#flatten_merge needs to remain protected so that it can be called on other instances of Set. Take a look at Set#flatten for the example of that. I'm not sure it's useful outside that context which is why I favored marking it :nodoc: rather than adding actual documentation. That's just my opinion though, so feel free to document this function if you like.
----------------------------------------
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