Forum: Ruby-core [ruby-trunk - Bug #8889][Open] Nodoc large parts of RSS

233c279c012ebac792aaa805f966cbc7?d=identicon&s=25 steveklabnik (Steve Klabnik) (Guest)
on 2013-09-10 22:18
(Received via mailing list)
Issue #8889 has been reported by steveklabnik (Steve Klabnik).

----------------------------------------
Bug #8889: Nodoc large parts of RSS
https://bugs.ruby-lang.org/issues/8889

Author: steveklabnik (Steve Klabnik)
Status: Open
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.
054b5f6b8afdd5f6190bad08e46cd782?d=identicon&s=25 zzak (Zachary Scott) (Guest)
on 2013-09-26 17:26
(Received via mailing list)
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.
233c279c012ebac792aaa805f966cbc7?d=identicon&s=25 steveklabnik (Steve Klabnik) (Guest)
on 2013-10-09 09:02
(Received via mailing list)
Issue #8889 has been updated by steveklabnik (Steve Klabnik).


Sounds good to me. I'm not sure when I will get to it, but that makes
sense.
----------------------------------------
Bug #8889: Nodoc large parts of RSS
https://bugs.ruby-lang.org/issues/8889#change-42366

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.
054b5f6b8afdd5f6190bad08e46cd782?d=identicon&s=25 zzak (Zachary Scott) (Guest)
on 2013-10-15 17:19
(Received via mailing list)
Issue #8889 has been updated by zzak (Zachary Scott).

Status changed from Feedback to Rejected

See ruby-core:57399

Thank you for the patch! Please send more :)
----------------------------------------
Bug #8889: Nodoc large parts of RSS
https://bugs.ruby-lang.org/issues/8889#change-42476

Author: steveklabnik (Steve Klabnik)
Status: Rejected
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.
This topic is locked and can not be replied to.