ruby-changes:25402
From: tadf <ko1@a...>
Date: Sat, 3 Nov 2012 22:40:07 +0900 (JST)
Subject: [ruby-changes:25402] tadf:r37459 (trunk): * ext/date/date_core.c: modified doc.
tadf 2012-11-03 22:39:54 +0900 (Sat, 03 Nov 2012) New Revision: 37459 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=37459 Log: * ext/date/date_core.c: modified doc. Modified files: trunk/ChangeLog trunk/ext/date/date_core.c Index: ChangeLog =================================================================== --- ChangeLog (revision 37458) +++ ChangeLog (revision 37459) @@ -1,3 +1,7 @@ +Sat Nov 3 22:38:55 2012 Tadayoshi Funaba <tadf@d...> + + * ext/date/date_core.c: modified doc. + Sat Nov 3 18:35:55 2012 Kazuki Tsujimoto <kazuki@c...> * vm.c (rb_vm_rewrite_ep_in_errinfo, vm_rewrite_ep_in_errinfo): Index: ext/date/date_core.c =================================================================== --- ext/date/date_core.c (revision 37458) +++ ext/date/date_core.c (revision 37459) @@ -2426,8 +2426,6 @@ * * Just returns true. It's nonsense, but is for symmetry. * - * For example: - * * Date.valid_jd?(2451944) #=> true * * See also jd. @@ -2516,8 +2514,6 @@ * * Returns true if the given calendar date is valid, and false if not. * - * For example: - * * Date.valid_date?(2001,2,3) #=> true * Date.valid_date?(2001,2,29) #=> false * @@ -2599,8 +2595,6 @@ * * Returns true if the given ordinal date is valid, and false if not. * - * For example: - * * Date.valid_ordinal?(2001,34) #=> true * Date.valid_ordinal?(2001,366) #=> false * @@ -2683,8 +2677,6 @@ * * Returns true if the given week date is valid, and false if not. * - * For example: - * * Date.valid_commercial?(2001,5,6) #=> true * Date.valid_commercial?(2001,5,8) #=> false * @@ -2870,8 +2862,6 @@ * Returns true if the given year is a leap year of the proleptic * Julian calendar. * - * For example: - * * Date.julian_leap?(1900) #=> true * Date.julian_leap?(1901) #=> false */ @@ -2893,8 +2883,6 @@ * Returns true if the given year is a leap year of the proleptic * Gregorian calendar. * - * For example: - * * Date.gregorian_leap?(1900) #=> false * Date.gregorian_leap?(2000) #=> true */ @@ -3222,8 +3210,6 @@ * Creates a date object denoting the given chronological Julian day * number. * - * For example: - * * Date.jd(2451944) #=> #<Date: 2001-02-03 ...> * Date.jd(2451945) #=> #<Date: 2001-02-04 ...> * Date.jd(0) #=> #<Date: -4712-01-01 ...> @@ -3274,8 +3260,6 @@ * relative day from the end of year when negative). It should not be * zero. * - * For example: - * * Date.ordinal(2001) #=> #<Date: 2001-01-01 ...> * Date.ordinal(2001,34) #=> #<Date: 2001-02-03 ...> * Date.ordinal(2001,-1) #=> #<Date: 2001-12-31 ...> @@ -3344,8 +3328,6 @@ * Gregorian calendar) and Date::JULIAN (the proleptic Julian * calendar) can be specified as a day of calendar reform. * - * For example: - * * Date.new(2001) #=> #<Date: 2001-01-01 ...> * Date.new(2001,2,3) #=> #<Date: 2001-02-03 ...> * Date.new(2001,2,-1) #=> #<Date: 2001-02-28 ...> @@ -3423,8 +3405,6 @@ * number (as a relative week/day from the end of year/week when * negative). They should not be zero. * - * For example: - * * Date.commercial(2001) #=> #<Date: 2001-01-01 ...> * Date.commercial(2002) #=> #<Date: 2001-12-31 ...> * Date.commercial(2001,5,6) #=> #<Date: 2001-02-03 ...> @@ -3603,8 +3583,6 @@ * call-seq: * Date.today([start=Date::ITALY]) -> date * - * For example: - * * Date.today #=> #<Date: 2011-06-11 ..> * * Creates a date object denoting the present day. @@ -4203,8 +4181,6 @@ * template, and returns a hash of parsed elements. _strptime does * not support specification of flags and width unlike strftime. * - * For example: - * * Date._strptime('2001-02-03', '%Y-%m-%d') * #=> {:year=>2001, :mon=>2, :mday=>3} * @@ -4224,8 +4200,6 @@ * template, and creates a date object. strptime does not support * specification of flags and width unlike strftime. * - * For example: - * * Date.strptime('2001-02-03', '%Y-%m-%d') #=> #<Date: 2001-02-03 ...> * Date.strptime('??-??-????', '%d-%m-%Y') #=> #<Date: 2001-02-03 ...> * Date.strptime('2001-034', '%Y-%j') #=> #<Date: 2001-02-03 ...> @@ -4297,14 +4271,13 @@ * Date._parse(string[, comp=true]) -> hash * * Parses the given representation of date and time, and returns a - * hash of parsed elements. + * hash of parsed elements. This method does not function as a + * validator. * * If the optional second argument is true and the detected year is in * the range "00" to "99", considers the year a 2-digit form and makes * it full. * - * For example: - * * Date._parse('2001-02-03') #=> {:year=>2001, :mon=>2, :mday=>3} */ static VALUE @@ -4318,14 +4291,12 @@ * Date.parse(string='-4712-01-01'[, comp=true[, start=ITALY]]) -> date * * Parses the given representation of date and time, and creates a - * date object. + * date object. This method does not function as a validator. * * If the optional second argument is true and the detected year is in * the range "00" to "99", considers the year a 2-digit form and makes * it full. * - * For example: - * * Date.parse('2001-02-03') #=> #<Date: 2001-02-03 ...> * Date.parse('20010203') #=> #<Date: 2001-02-03 ...> * Date.parse('3rd Feb 2001') #=> #<Date: 2001-02-03 ...> @@ -4382,8 +4353,6 @@ * Creates a new Date object by parsing from a string according to * some typical ISO 8601 formats. * - * For example: - * * Date.iso8601('2001-02-03') #=> #<Date: 2001-02-03 ...> * Date.iso8601('20010203') #=> #<Date: 2001-02-03 ...> * Date.iso8601('2001-W05-6') #=> #<Date: 2001-02-03 ...> @@ -4427,8 +4396,6 @@ * Creates a new Date object by parsing from a string according to * some typical RFC 3339 formats. * - * For example: - * * Date.rfc3339('2001-02-03T04:05:06+07:00') #=> #<Date: 2001-02-03 ...> */ static VALUE @@ -4470,8 +4437,6 @@ * Creates a new Date object by parsing from a string according to * some typical XML Schema formats. * - * For example: - * * Date.xmlschema('2001-02-03') #=> #<Date: 2001-02-03 ...> */ static VALUE @@ -4515,8 +4480,6 @@ * Creates a new Date object by parsing from a string according to * some typical RFC 2822 formats. * - * For example: - * * Date.rfc2822('Sat, 3 Feb 2001 00:00:00 +0000') * #=> #<Date: 2001-02-03 ...> */ @@ -4559,11 +4522,8 @@ * Creates a new Date object by parsing from a string according to * some RFC 2616 format. * - * For example: - * * Date.httpdate('Sat, 03 Feb 2001 00:00:00 GMT') * #=> #<Date: 2001-02-03 ...> - * */ static VALUE date_s_httpdate(int argc, VALUE *argv, VALUE klass) @@ -4604,8 +4564,6 @@ * Creates a new Date object by parsing from a string according to * some typical JIS X 0301 formats. * - * For example: - * * Date.jisx0301('H13.02.03') #=> #<Date: 2001-02-03 ...> */ static VALUE @@ -4797,8 +4755,6 @@ * Returns the astronomical Julian day number. This is a fractional * number, which is not adjusted by the offset. * - * For example: - * * DateTime.new(2001,2,3,4,5,6,'+7').ajd #=> (11769328217/4800) * DateTime.new(2001,2,2,14,5,6,'-7').ajd #=> (11769328217/4800) */ @@ -4816,8 +4772,6 @@ * Returns the astronomical modified Julian day number. This is * a fractional number, which is not adjusted by the offset. * - * For example: - * * DateTime.new(2001,2,3,4,5,6,'+7').amjd #=> (249325817/4800) * DateTime.new(2001,2,2,14,5,6,'-7').amjd #=> (249325817/4800) */ @@ -4835,8 +4789,6 @@ * Returns the Julian day number. This is a whole number, which is * adjusted by the offset as the local time. * - * For example: - * * DateTime.new(2001,2,3,4,5,6,'+7').jd #=> 2451944 * DateTime.new(2001,2,3,4,5,6,'-7').jd #=> 2451944 */ @@ -4854,8 +4806,6 @@ * Returns the modified Julian day number. This is a whole number, * which is adjusted by the offset as the local time. * - * For example: - * * DateTime.new(2001,2,3,4,5,6,'+7').mjd #=> 51943 * DateTime.new(2001,2,3,4,5,6,'-7').mjd #=> 51943 */ @@ -4873,8 +4823,6 @@ * Returns the Lilian day number. This is a whole number, which is * adjusted by the offset as the local time. * - * For example: - * * Date.new(2001,2,3).ld #=> 152784 */ static VALUE @@ -4890,8 +4838,6 @@ * * Returns the year. * - * For example: - * * Date.new(2001,2,3).year #=> 2001 * (Date.new(1,1,1) - 1).year #=> 0 */ @@ -4908,8 +4854,6 @@ * * Returns the day of the year (1-366). * - * For example: - * * Date.new(2001,2,3).yday #=> 34 */ static VALUE @@ -4926,8 +4870,6 @@ * * Returns the month (1-12). * - * For example: - * * Date.new(2001,2,3).mon #=> 2 */ static VALUE @@ -4944,8 +4886,6 @@ * * Returns the day of the month (1-31). * - * For example: - * * Date.new(2001,2,3).mday #=> 3 */ static VALUE @@ -4961,8 +4901,6 @@ * * Returns the fractional part of the day. * - * For example: - * * DateTime.new(2001,2,3,12).day_fraction #=> (1/2) */ static VALUE @@ -4980,8 +4918,6 @@ * * Returns the calendar week based year. * - * For example: - * * Date.new(2001,2,3).cwyear #=> 2001 * Date.new(2000,1,1).cwyear #=> 1999 */ @@ -4998,8 +4934,6 @@ * * Returns the calendar week number (1-53). * - * For example: - * * Date.new(2001,2,3).cweek #=> 5 */ static VALUE @@ -5015,8 +4949,6 @@ * * Returns the day of calendar week (1-7, Monday is 1). * - * For example: - * * Date.new(2001,2,3).cwday #=> 6 */ static VALUE @@ -5048,8 +4980,6 @@ * * Returns the day of week (0-6, Sunday is zero). * - * For example: - * * Date.new(2001,2,3).wday #=> 6 */ static VALUE @@ -5176,8 +5106,6 @@ * * Returns the hour (0-23). * - * For example: - * * DateTime.new(2001,2,3,4,5,6).hour #=> 4 */ static VALUE @@ -5194,8 +5122,6 @@ * * Returns the minute (0-59). * - * For example: - * * DateTime.new(2001,2,3,4,5,6).min #=> 5 */ static VALUE @@ -5212,8 +5138,6 @@ * * Returns the second (0-59). * - * For example: - * * DateTime.new(2001,2,3,4,5,6).sec #=> 6 */ static VALUE @@ -5230,8 +5154,6 @@ * * Returns the fractional part of the second. * - * For example: - * * DateTime.new(2001,2,3,4,5,6.5).sec_fraction #=> (1/2) */ static VALUE @@ -5247,8 +5169,6 @@ * * Returns the offset. * - * For example: - * * DateTime.parse('04pm+0730').offset #=> (5/16) */ static VALUE @@ -5264,8 +5184,6 @@ * * Returns the timezone. * - * For example: - * * DateTime.parse('04pm+0730').zone #=> "+07:30" */ static VALUE @@ -5281,8 +5199,6 @@ * * Retruns true if the date is before the day of calendar reform. * - * For example: - * * Date.new(1582,10,15).julian? #=> false * (Date.new(1582,10,15) - 1).julian? #=> true */ @@ -5299,8 +5215,6 @@ * * Retunrs true if the date is on or after the day of calendar reform. * - * For example: - * * Date.new(1582,10,15).gregorian? #=> true * (Date.new(1582,10,15) - 1).gregorian? #=> false */ @@ -5317,8 +5231,6 @@ * * Returns true if the year is a leap year. * - * For example: - * * Date.new(2000).leap? #=> true * Date.new(2001).leap? #=> false */ @@ -5343,8 +5255,6 @@ * * Returns the Julian day number denoting the day of calendar reform. * - * For example: - * * Date.new(2001,2,3).start #=> 2299161.0 * Date.new(2001,2,3,Date::GREGORIAN).start #=> -Infinity */ @@ -5415,8 +5325,6 @@ * * Duplicates self and resets its the day of calendar reform. * - * For example: - * * d = Date.new(1582,10,15) * d.new_start(Date::JULIAN) #=> #<Date: 1582-10-05 ...> */ @@ -5510,8 +5418,6 @@ * * Duplicates self and resets its offset. * - * For example: - * * d = DateTime.new(2001,2,3,4,5,6,'-02:00') * #=> #<DateTime: 2001-02-03T04:05:06-02:00 ...> * d.new_offset('+09:00') #=> #<DateTime: 2001-02-03T15:05:06+09:00 ...> @@ -5539,8 +5445,6 @@ * should be a numeric value. If the other is flonum, assumes its * precision is at most nanosecond. * - * For example: - * * Date.new(2001,2,3) + 1 #=> #<Date: 2001-02-04 ...> * DateTime.new(2001,2,3) + Rational(1,2) * #=> #<DateTime: 2001-02-03T12:00:00+00:00 ...> @@ -5963,8 +5867,6 @@ * pointing other days before self. If the other is flonum, assumes * its precision is at most nanosecond. * - * For example: - * * Date.new(2001,2,3) - 1 #=> #<Date: 2001-02-02 ...> * DateTime.new(2001,2,3) - Rational(1,2) * #=> #<DateTime: 2001-02-02T12:00:00+00:00 ...> @@ -6047,8 +5949,6 @@ * Returns a date object pointing n months after self. The n should * be a numeric value. * - * For example: - * * Date.new(2001,2,3) >> 1 #=> #<Date: 2001-03-03 ...> * Date.new(2001,1,31) >> 1 #=> #<Date: 2001-02-28 ...> * Date.new(2001,2,3) >> -2 #=> #<Date: 2000-12-03 ...> @@ -6099,8 +5999,6 @@ * Returns a date object pointing n months before self. The n should * be a numeric value. * - * For example: - * * Date.new(2001,2,3) << 1 #=> #<Date: 2001-01-03 ...> * Date.new(2001,1,31) << 11 #=> #<Date: 2000-02-29 ...> * Date.new(2001,2,3) << -1 #=> #<Date: 2001-03-03 ...> @@ -6189,8 +6087,6 @@ * Iterates evaluation of the given block, which takes a date object. * The limit should be a date object. * - * For example: - * * Date.new(2001).step(Date.new(2001,-1,-1)).select{|d| d.sunday?}.size * #=> 52 */ @@ -6354,8 +6250,6 @@ * should be a date object or a numeric value as an astronomical * Julian day number. * - * For example: - * * Date.new(2001,2,3) <=> Date.new(2001,2,4) #=> -1 * Date.new(2001,2,3) <=> Date.new(2001,2,3) #=> 0 * Date.new(2001,2,3) <=> Date.new(2001,2,2) #=> 1 @@ -6493,8 +6387,6 @@ * * Returns true if they are the same day. * - * For example: - * * Date.new(2001,2,3) === Date.new(2001,2,3) * #=> true * Date.new(2001,2,3) === Date.new(2001,2,4) @@ -6610,8 +6502,6 @@ * Returns a string in an ISO 8601 format (This method doesn't use the * expanded representations). * - * For example: - * * Date.new(2001,2,3).to_s #=> "2001-02-03" */ static VALUE @@ -6714,13 +6604,10 @@ * * Returns the value as a string for inspection. * - * For example: - * * Date.new(2001,2,3).inspect * #=> "#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>" * DateTime.new(2001,2,3,4,5,6,'-7').inspect * #=> "#<DateTime: 2001-02-03T04:05:06-07:00 ((2451944j,39906s,0n),-25200s,2299161j)>" - * */ static VALUE d_lite_inspect(VALUE self) @@ -7204,8 +7091,6 @@ * * Returns a string in a JIS X 0301 format. * - * For example: - * * Date.new(2001,2,3).jisx0301 #=> "H13.02.03" */ static VALUE @@ -7373,8 +7258,6 @@ * Creates a datetime object denoting the given chronological Julian * day number. * - * For example: - * * DateTime.jd(2451944) #=> #<DateTime: 2001-02-03T00:00:00+00:00 ...> * DateTime.jd(2451945) #=> #<DateTime: 2001-02-04T00:00:00+00:00 ...> * DateTime.jd(Rational('0.5')) @@ -7442,8 +7325,6 @@ * * Creates a date-time object denoting the given ordinal date. * - * For example: - * * DateTime.ordinal(2001,34) #=> #<DateTime: 2001-02-03T00:00:00+00:00 ...> * DateTime.ordinal(2001,34,4,5,6,'+7') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> @@ -7520,8 +7401,6 @@ * * Creates a date-time object denoting the given calendar date. * - * For example: - * * DateTime.new(2001,2,3) #=> #<DateTime: 2001-02-03T00:00:00+00:00 ...> * DateTime.new(2001,2,3,4,5,6,'+7') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> @@ -7620,8 +7499,6 @@ * * Creates a date-time object denoting the given week date. * - * For example: - * * DateTime.commercial(2001) #=> #<DateTime: 2001-01-01T00:00:00+00:00 ...> * DateTime.commercial(2002) #=> #<DateTime: 2001-12-31T00:00:00+00:00 ...> * DateTime.commercial(2001,5,6,4,5,6,'+7') @@ -7839,8 +7716,6 @@ * * Creates a date-time object denoting the present time. * - * For example: - * * DateTime.now #=> #<DateTime: 2011-06-11T21:20:44+09:00 ...> */ static VALUE @@ -8058,8 +7933,6 @@ * template, and creates a date object. strptime does not support * specification of flags and width unlike strftime. * - * For example: - * * DateTime.strptime('2001-02-03T04:05:06+07:00', '%Y-%m-%dT%H:%M:%S%z') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> * DateTime.strptime('??-??-???? 04:05:06 PM', '%d-%m-%Y %I:%M:%S %p') @@ -8110,13 +7983,11 @@ * DateTime.parse(string='-4712-01-01T00:00:00+00:00'[, comp=true[, start=ITALY]]) -> datetime * * Parses the given representation of date and time, and creates a - * date object. + * date object. This method does not function as a validator. * * If the optional second argument is true and the detected year is in * the range "00" to "99", makes it full. * - * For example: - * * DateTime.parse('2001-02-03T04:05:06+07:00') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> * DateTime.parse('20010203T040506+0700') @@ -8157,8 +8028,6 @@ * Creates a new Date object by parsing from a string according to * some typical ISO 8601 formats. * - * For example: - * * DateTime.iso8601('2001-02-03T04:05:06+07:00') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> * DateTime.iso8601('20010203T040506+0700') @@ -8193,8 +8062,6 @@ * Creates a new Date object by parsing from a string according to * some typical RFC 3339 formats. * - * For example: - * * DateTime.rfc3339('2001-02-03T04:05:06+07:00') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> */ @@ -8225,8 +8092,6 @@ * Creates a new Date object by parsing from a string according to * some typical XML Schema formats. * - * For example: - * * DateTime.xmlschema('2001-02-03T04:05:06+07:00') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> */ @@ -8258,8 +8123,6 @@ * Creates a new Date object by parsing from a string according to * some typical RFC 2822 formats. * - * For example: - * * DateTime.rfc2822('Sat, 3 Feb 2001 04:05:06 +0700') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> */ @@ -8290,8 +8153,6 @@ * Creates a new Date object by parsing from a string according to * some RFC 2616 format. * - * For example: - * * DateTime.httpdate('Sat, 03 Feb 2001 04:05:06 GMT') * #=> #<DateTime: 2001-02-03T04:05:06+00:00 ...> */ @@ -8322,8 +8183,6 @@ * Creates a new Date object by parsing from a string according to * some typical JIS X 0301 formats. * - * For example: - * * DateTime.jisx0301('H13.02.03T04:05:06+07:00') * #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...> */ @@ -8354,8 +8213,6 @@ * Returns a string in an ISO 8601 format (This method doesn't use the * expanded representations). * - * For example: - * * DateTime.new(2001,2,3,4,5,6,'-7').to_s * #=> "2001-02-03T04:05:06-07:00" */ @@ -8580,8 +8437,6 @@ * This method is equivalent to strftime('%FT%T'). The optional * argument n is length of fractional seconds. * - * For example: - * * DateTime.parse('2001-02-03T04:05:06.123456789+07:00').iso8601(9) * #=> "2001-02-03T04:05:06.123456789+07:00" */ @@ -8606,8 +8461,6 @@ * This method is equivalent to strftime('%FT%T'). The optional * argument n is length of fractional seconds. * - * For example: - * * DateTime.parse('2001-02-03T04:05:06.123456789+07:00').rfc3339(9) * #=> "2001-02-03T04:05:06.123456789+07:00" */ @@ -8624,8 +8477,6 @@ * Returns a string in a JIS X 0301 format. The optional argument n * is length of fractional seconds. * - * For example: - * * DateTime.parse('2001-02-03T04:05:06.123456789+07:00').jisx0301(9) * #=> "H13.02.03T04:05:06.123456789+07:00" */ -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/