Bug #4663

Add initial documentation for RSS

Added by Steve Klabnik almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36082]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:-
ruby -v:1.9.2-p180 Backport:

Description

As part of the Ruby 1.9.3 documentation challenge[1], here's my first shot at adding some documentation to the RSS portion of the standard library. I've just added an overview with two examples, but I plan on fleshing out the rest of RSS, too. I wanted to make sure that I'm doing it right with something small before I put in a bunch of time on a bigger patch.

Patch included.

1: http://blog.segment7.net/2011/05/09/ruby-1-9-3-documentation-challenge

0001-lib-rss.rb-Add-Documentation.patch Magnifier (3.5 KB) Steve Klabnik, 05/10/2011 02:03 PM

0001-Adding-documentation-to-lib-rss.rb.patch Magnifier (3.51 KB) Steve Klabnik, 05/11/2011 02:27 AM

Associated revisions

Revision 31503
Added by Eric Hodel almost 3 years ago

  • lib/rss.rb: Add documentation. Patch by Steve Klabnik. [Ruby 1.9 - Bug #4663]

History

#1 Updated by Steve Klabnik almost 3 years ago

Due to writing this at 5am, I misspelled 'Syndication." Whoops. Here's the corrected patch.

#2 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31503.
Steve, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/rss.rb: Add documentation. Patch by Steve Klabnik. [Ruby 1.9 - Bug #4663]

#3 Updated by Eric Hodel almost 3 years ago

I made a few modifications to the original patch:

Added a module RSS after the comment to attach the documentation properly.

Maintained the author's license line

Maintained a link to the author's tutorial as it still seems valid.

Thanks!

Also available in: Atom PDF