[ruby-core:57399] [ruby-trunk - Bug #8889][Feedback] Nodoc large parts of RSS

Issue #8889 has been updated by zzak (Zachary Scott).

Status changed from Open to Feedback

I like RSS, I think we should provide api-level documentation for things like Feed and Channel and Entry. The entity types might not be as important though.

Would you agree? With no objection, I would like to reject this ticket and ask for a new patch.


Thank you!
----------------------------------------
Bug #8889: Nodoc large parts of RSS
https://bugs.ruby-lang.org/issues/8889#change-42000

Author: steveklabnik (Steve Klabnik)
Status: Feedback
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: 
ruby -v: 2.1.0-dev
Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN


Continuing my focus on getting RSS documented, I believe that large amounts of it should be nodoc'd. The vast majority of the code is actually internal implementation detail; the big stuff is the builder DSL, which isn't really served by API-level documentation.

The attached patch nodocs everything that's in the top-level files, those being the ones for the specific formats. If it's agreed that most of the rest should be nodoc'd as well, I can do that in another patch, or if we do want api-level docs for all of this, I can work on actually writing those.


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