From 196d348a610113b35ece6e78b27290028bdd1871 Mon Sep 17 00:00:00 2001 From: zzak Date: Mon, 5 Aug 2013 16:25:04 +0000 Subject: [PATCH] * lib/rss/2.0.rb: [DOC] Document RSS::Rss by Steve Klabnik #8740 * lib/rss/atom.rb: [DOC] Typo in rdoc by Steve Klabnik git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42388 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ lib/rss/2.0.rb | 31 +++++++++++++++++++++++++++++++ lib/rss/atom.rb | 2 +- 3 files changed, 37 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index e463245d01..e9792872a5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Aug 6 01:22:37 2013 Zachary Scott + + * 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 * bignum.c: Rename local variables. diff --git a/lib/rss/2.0.rb b/lib/rss/2.0.rb index 9622c598d9..5c0caecd73 100644 --- a/lib/rss/2.0.rb +++ b/lib/rss/2.0.rb @@ -2,6 +2,37 @@ require "rss/0.9" 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 diff --git a/lib/rss/atom.rb b/lib/rss/atom.rb index fc16a381c1..d3524231ff 100644 --- a/lib/rss/atom.rb +++ b/lib/rss/atom.rb @@ -8,7 +8,7 @@ module RSS # # 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 ##