drbrain	2011-05-21 02:37:02 +0900 (Sat, 21 May 2011)

  New Revision: 31650

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

  Log:
    * ext/date/lib/date/format.rb:  Document date formats.  Patch by
      Clinton Nixon.  [Ruby 1.9 - Bug #4743]

  Modified files:
    trunk/ChangeLog
    trunk/ext/date/lib/date/format.rb

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 31649)
+++ ChangeLog	(revision 31650)
@@ -1,3 +1,8 @@
+Sat May 21 02:22:34 2011  Eric Hodel  <drbrain@s...>
+
+	* ext/date/lib/date/format.rb:  Document date formats.  Patch by
+	  Clinton Nixon.  [Ruby 1.9 - Bug #4743]
+
 Fri May 20 05:15:19 2011  Nobuhiro Iwamatsu  <iwamatsu@n...>
 
 	* gc.c: Fix build on m68k by 'error: too few arguments to
Index: ext/date/lib/date/format.rb
===================================================================
--- ext/date/lib/date/format.rb	(revision 31649)
+++ ext/date/lib/date/format.rb	(revision 31650)
@@ -1,4 +1,6 @@
+#--
 # format.rb: Written by Tadayoshi Funaba 1999-2011
+#++
 
 class Date
 
@@ -110,22 +112,44 @@
 
   end
 
+  # Returns a String representing this Date in the form:
+  # Sun Sep 30 00:00:00 1977.
   def asctime() strftime('%c') end
 
   alias_method :ctime, :asctime
 
+  # Returns a String representing this Date in the form:
+  # 1977-09-30.
+  #
+  # This form is in accordance with
+  # ISO8601[http://www.iso.org/iso/support/faqs/faqs_widely_used_standards/widely_used_standards_other/date_and_time_format.htm].
   def iso8601() strftime('%F') end
 
+  # Returns a String representing this Date in the form:
+  # 1977-09-30T00:00:00+00:00
+  #
+  # This form is in accordance with the format for a timestamp in
+  # RFC3339[http://www.ietf.org/rfc/rfc3339.txt].
   def rfc3339() strftime('%FT%T%:z') end
 
+  # Synonym for Date.iso8601.
   def xmlschema() iso8601 end # :nodoc:
 
+  # Returns a String representing this Date in the form:
+  # Fri, 30 Sep 1977 00:00:00 +0000
+  #
+  # This form is in accordance with the format for a full
+  # date and time specification in
+  # RFC2822[http://www.ietf.org/rfc/rfc2822.txt].
   def rfc2822() strftime('%a, %-d %b %Y %T %z') end
 
   alias_method :rfc822, :rfc2822
 
   def httpdate() new_offset(0).strftime('%a, %d %b %Y %T GMT') end # :nodoc:
 
+  # Returns a String representing this Date in a form
+  # that is in accordance with the Japanese specification
+  # JIS X 0301.
   def jisx0301
     if jd < 2405160
       strftime('%F')

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