zzak	2013-08-06 01:25:04 +0900 (Tue, 06 Aug 2013)

  New Revision: 42388

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=42388

  Log:
    * lib/rss/2.0.rb: [DOC] Document RSS::Rss by Steve Klabnik #8740
    * lib/rss/atom.rb: [DOC] Typo in rdoc by Steve Klabnik

  Modified files:
    trunk/ChangeLog
    trunk/lib/rss/2.0.rb
    trunk/lib/rss/atom.rb

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 42387)
+++ ChangeLog	(revision 42388)
@@ -1,3 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1
+Tue Aug  6 01:22:37 2013  Zachary Scott  <e@z...>
+
+	* lib/rss/2.0.rb: [DOC] Document RSS::Rss by Steve Klabnik #8740
+	* lib/rss/atom.rb: [DOC] Typo in rdoc by Steve Klabnik
+
 Mon Aug  5 23:47:59 2013  Tanaka Akira  <akr@f...>
 
 	* bignum.c: Rename local variables.
Index: lib/rss/2.0.rb
===================================================================
--- lib/rss/2.0.rb	(revision 42387)
+++ lib/rss/2.0.rb	(revision 42388)
@@ -2,6 +2,37 @@ require "rss/0.9" https://github.com/ruby/ruby/blob/trunk/lib/rss/2.0.rb#L2
 
 module RSS
 
+  ##
+  # = RSS 2.0 support
+  #
+  # RSS has three different versions. This module contains support for version
+  # 2.0[http://www.rssboard.org/rss-specification]
+  #
+  # == Producing RSS 2.0
+  #
+  # Producing our own RSS feeds is easy as well. Let's make a very basic feed:
+  #
+  #  require "rss"
+  #
+  #  rss = RSS::Maker.make("2.0") do |maker|
+  #    maker.channel.language = "en"
+  #    maker.channel.author = "matz"
+  #    maker.channel.updated = Time.now.to_s
+  #    maker.channel.link = "http://www.ruby-lang.org/en/feeds/news.rss"
+  #    maker.channel.title = "Example Feed"
+  #    maker.channel.description = "A longer description of my feed."
+  #    maker.items.new_item do |item|
+  #      item.link = "http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
+  #      item.title = "Ruby 1.9.2-p136 is released"
+  #      item.updated = Time.now.to_s
+  #    end
+  #  end
+  #
+  #  puts rss
+  #
+  # As you can see, this is a very Builder-like DSL. This code will spit out an
+  # RSS 2.0 feed with one item. If we needed a second item, we'd make another
+  # block with maker.items.new_item and build a second one.
   class Rss
 
     class Channel
Index: lib/rss/atom.rb
===================================================================
--- lib/rss/atom.rb	(revision 42387)
+++ lib/rss/atom.rb	(revision 42388)
@@ -8,7 +8,7 @@ module RSS https://github.com/ruby/ruby/blob/trunk/lib/rss/atom.rb#L8
   #
   # The Atom module provides support in reading and creating feeds.
   #
-  # See the RSS module for examples consuming and creating feeds
+  # See the RSS module for examples consuming and creating feeds.
   module Atom
 
     ##

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/