diff options
author | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-10-09 14:49:49 +0000 |
---|---|---|
committer | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-10-09 14:49:49 +0000 |
commit | bb9f40a725e780c279ebcc908fc39084d8bd2545 (patch) | |
tree | f899cdae77850820e17d14e7e0536e646edea623 /lib/parsedate.rb | |
parent | 88d6c083ea969b5e7b24315fd612958755afcc54 (diff) | |
download | ruby-bb9f40a725e780c279ebcc908fc39084d8bd2545.tar.gz |
* lib/parsedate.rb: documentation patch from Konrad Meyer
<konrad.meyer@gmail.com>. [ruby-doc:1238]
* lib/open3.rb, lib/ping.rb: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11113 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/parsedate.rb')
-rw-r--r-- | lib/parsedate.rb | 44 |
1 files changed, 41 insertions, 3 deletions
diff --git a/lib/parsedate.rb b/lib/parsedate.rb index 405ab46907..b52a79ba47 100644 --- a/lib/parsedate.rb +++ b/lib/parsedate.rb @@ -1,10 +1,48 @@ -# parsedate.rb: Written by Tadayoshi Funaba 2001, 2002 -# $Id: parsedate.rb,v 2.6 2002-05-14 07:43:18+09 tadf Exp $ +# +# = parsedate.rb: Parses dates +# +# Author:: Tadayoshi Funaba +# Documentation:: Konrad Meyer +# +# ParseDate munches on a date and turns it into an array of values. +# + +# +# ParseDate converts a date into an array of values. +# For example: +# +# require 'parsedate' +# +# ParseDate.parsedate "Tuesday, July 6th, 2007, 18:35:20 UTC" +# # => [2007, 7, 6, 18, 35, 20, "UTC", 2] +# +# The order is of the form [year, month, day of month, hour, minute, second, +# timezone, day of the week]. require 'date/format' module ParseDate - + # + # Parse a string representation of a date into values. + # For example: + # + # require 'parsedate' + # + # ParseDate.parsedate "Tuesday, July 5th, 2007, 18:35:20 UTC" + # # => [2007, 7, 5, 18, 35, 20, "UTC", 2] + # + # The order is of the form [year, month, day of month, hour, minute, + # second, timezone, day of week]. + # + # ParseDate.parsedate can also take a second argument, +comp+, which + # is a boolean telling the method to compensate for dates with years + # expressed as two digits. Example: + # + # require 'parsedate' + # + # ParseDate.parsedate "Mon Dec 25 00 06:53:24 UTC", true + # # => [2000, 12, 25, 6, 53, 24, "UTC", 1] + # def parsedate(str, comp=false) Date._parse(str, comp). values_at(:year, :mon, :mday, :hour, :min, :sec, :zone, :wday) |