Bug #4663: Add initial documentation for RSS

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: -
• ruby -v: 1.9.2-p180

[steveklabnik (Steve Klabnik)]

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

[steveklabnik (Steve Klabnik)]

• File 0001-Adding-documentation-to-lib-rss.rb.patch 0001-Adding-documentation-to-lib-rss.rb.patch added

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

[drbrain (Eric Hodel)]

• 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]

[drbrain (Eric Hodel)]

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!