ruby-changes:73060
From: Burdette <ko1@a...>
Date: Fri, 26 Aug 2022 03:02:35 +0900 (JST)
Subject: [ruby-changes:73060] 8706b74b90 (master): [DOC] Enhanced RDoc for Time (#6277)
https://git.ruby-lang.org/ruby.git/commit/?id=8706b74b90 From 8706b74b902db70c5c00c8008a0f0b045381eb7e Mon Sep 17 00:00:00 2001 From: Burdette Lamar <BurdetteLamar@Y...> Date: Thu, 25 Aug 2022 13:02:18 -0500 Subject: [DOC] Enhanced RDoc for Time (#6277) Deletes the :include: files in doc/time, which became no longer workable when @nobu pointed out that some (but not all) creator methods accept string values as well as integer-like values. Changes to methods: Time.utc Time.local Time.at Time.new --- doc/time/in.rdoc | 4 -- doc/time/mon-min.rdoc | 8 --- doc/time/msec.rdoc | 2 - doc/time/nsec.rdoc | 2 - doc/time/sec.rdoc | 2 - doc/time/sec_i.rdoc | 1 - doc/time/usec.rdoc | 2 - doc/time/year.rdoc | 1 - doc/time/zone_and_in.rdoc | 5 -- time.c | 145 +++++++++++++++++++++++++++++-------------- timev.rb | 155 +++++++++++++++++++++++++++++++++------------- 11 files changed, 209 insertions(+), 118 deletions(-) delete mode 100644 doc/time/in.rdoc delete mode 100644 doc/time/mon-min.rdoc delete mode 100644 doc/time/msec.rdoc delete mode 100644 doc/time/nsec.rdoc delete mode 100644 doc/time/sec.rdoc delete mode 100644 doc/time/sec_i.rdoc delete mode 100644 doc/time/usec.rdoc delete mode 100644 doc/time/year.rdoc delete mode 100644 doc/time/zone_and_in.rdoc diff --git a/doc/time/in.rdoc b/doc/time/in.rdoc deleted file mode 100644 index 506bd91628..0000000000 --- a/doc/time/in.rdoc +++ /dev/null @@ -1,4 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- <tt>in: zone</tt>: a timezone +zone+. - -For forms of argument +zone+, see -{Timezone Specifiers}[rdoc-ref:timezone_specifiers.rdoc]. diff --git a/doc/time/mon-min.rdoc b/doc/time/mon-min.rdoc deleted file mode 100644 index 5bd430c74a..0000000000 --- a/doc/time/mon-min.rdoc +++ /dev/null @@ -1,8 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +month+: a month value, which may be: - - An integer month in the range <tt>1..12</tt>. - - A 3-character string that matches regular expression - <tt>/jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec/i</tt>. -- +day+: an integer day in the range <tt>1..31</tt> - (less than 31 for some months). -- +hour+: an integer hour in the range <tt>0..23</tt>. -- +min+: an integer minute in the range <tt>0..59</tt>. diff --git a/doc/time/msec.rdoc b/doc/time/msec.rdoc deleted file mode 100644 index ce5d1e6145..0000000000 --- a/doc/time/msec.rdoc +++ /dev/null @@ -1,2 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +msec+ is the number of milliseconds (Integer, Float, or Rational) - in the range <tt>0..1000</tt>. diff --git a/doc/time/nsec.rdoc b/doc/time/nsec.rdoc deleted file mode 100644 index a2dfe2d608..0000000000 --- a/doc/time/nsec.rdoc +++ /dev/null @@ -1,2 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +nsec+ is the number of nanoseconds (Integer, Float, or Rational) - in the range <tt>0..1000000000</tt>. diff --git a/doc/time/sec.rdoc b/doc/time/sec.rdoc deleted file mode 100644 index 049c712110..0000000000 --- a/doc/time/sec.rdoc +++ /dev/null @@ -1,2 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +sec+ is the number of seconds (Integer, Float, or Rational) - in the range <tt>0..60</tt>. diff --git a/doc/time/sec_i.rdoc b/doc/time/sec_i.rdoc deleted file mode 100644 index fd5519082c..0000000000 --- a/doc/time/sec_i.rdoc +++ /dev/null @@ -1 +0,0 @@ -- +sec_i+ is the integer number of seconds in the range <tt>0..60</tt>. diff --git a/doc/time/usec.rdoc b/doc/time/usec.rdoc deleted file mode 100644 index bb5a46419a..0000000000 --- a/doc/time/usec.rdoc +++ /dev/null @@ -1,2 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +usec+ is the number of microseconds (Integer, Float, or Rational) - in the range <tt>0..1000000</tt>. diff --git a/doc/time/year.rdoc b/doc/time/year.rdoc deleted file mode 100644 index 2222b830d7..0000000000 --- a/doc/time/year.rdoc +++ /dev/null @@ -1 +0,0 @@ -- +year+: an integer year. diff --git a/doc/time/zone_and_in.rdoc b/doc/time/zone_and_in.rdoc deleted file mode 100644 index f36940ee13..0000000000 --- a/doc/time/zone_and_in.rdoc +++ /dev/null @@ -1,5 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/#L0 -- +zone+: a timezone +zone+. -- <tt>in: zone</tt>: a timezone +zone+. - -For forms of +zone+, see -{Timezone Specifiers}[rdoc-ref:timezone_specifiers.rdoc]. diff --git a/time.c b/time.c index d2d0de91e5..505ab4835c 100644 --- a/time.c +++ b/time.c @@ -3348,32 +3348,100 @@ tmcmp(struct tm *a, struct tm *b) https://github.com/ruby/ruby/blob/trunk/time.c#L3348 /* * call-seq: - * Time.utc(year, month = 1, day = 1, hour = 0, min = 0, sec_i = 0, usec = 0) -> new_time - * Time.utc(sec_i, min, hour, day, month, year, dummy, dummy, dummy, dummy) -> new_time + * Time.utc(year, month = 1, mday = 1, hour = 0, min = 0, sec = 0, usec = 0) -> new_time + * Time.utc(sec, min, hour, mday, month, year, dummy, dummy, dummy, dummy) -> new_time * - * Returns a new \Time object based the on given arguments; - * its timezone is UTC. + * Returns a new \Time object based the on given arguments, + * in the UTC timezone. * - * In the first form (up to seven arguments), argument +year+ is required. + * With one to seven arguments given, + * the arguments are interpreted as in the first calling sequence above: * - * Time.utc(2000) # => 2000-01-01 00:00:00 UTC - * Time.utc(0, 1, 2, 3, 4, 5, 6.5) # => 0000-01-02 03:04:05.0000065 UTC + * Time.utc(year, month = 1, mday = 1, hour = 0, min = 0, sec = 0, usec = 0) * - * In the second form, all ten arguments are required, - * though the last four are ignored. - * This form is useful for creating a time from a 10-element array - * such as is returned by #to_a. + * Examples: * - * array = Time.now.to_a - * # => [55, 14, 10, 7, 7, 2022, 4, 188, true, "Central Daylight Time"] - * array[5] = 2000 - * Time.utc(*array) # => 2000-07-07 10:14:55 UTC + * Time.utc(2000) # => 2000-01-01 00:00:00 UTC + * Time.utc(-2000) # => -2000-01-01 00:00:00 UTC * - * Parameters: - * :include: doc/time/year.rdoc - * :include: doc/time/mon-min.rdoc - * :include: doc/time/sec_i.rdoc - * :include: doc/time/usec.rdoc + * There are no minimum and maximum values for the required argument +year+. + * + * For the optional arguments: + * + * - +month+: Month in range (1..12), or case-insensitive + * 3-letter month name: + * + * Time.utc(2000, 1) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 12) # => 2000-12-01 00:00:00 UTC + * Time.utc(2000, 'jan') # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 'JAN') # => 2000-01-01 00:00:00 UTC + * + * - +mday+: Month day in range(1..31): + * + * Time.utc(2000, 1, 1) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 1, 31) # => 2000-01-31 00:00:00 UTC + * + * - +hour+: Hour in range (0..23), or 24 if +min+, +sec+, and +usec+ + * are zero: + * + * Time.utc(2000, 1, 1, 0) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 1, 1, 23) # => 2000-01-01 23:00:00 UTC + * Time.utc(2000, 1, 1, 24) # => 2000-01-02 00:00:00 UTC + * + * - +min+: Minute in range (0..59): + * + * Time.utc(2000, 1, 1, 0, 0) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 1, 1, 0, 59) # => 2000-01-01 00:59:00 UTC + * + * - +sec+: Second in range (0..59), or 60 if +usec+ is zero: + * + * Time.utc(2000, 1, 1, 0, 0, 0) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 1, 1, 0, 0, 59) # => 2000-01-01 00:00:59 UTC + * Time.utc(2000, 1, 1, 0, 0, 60) # => 2000-01-01 00:01:00 UTC + * + * - +usec+: Microsecond in range (0..999999): + * + * Time.utc(2000, 1, 1, 0, 0, 0, 0) # => 2000-01-01 00:00:00 UTC + * Time.utc(2000, 1, 1, 0, 0, 0, 999999) # => 2000-01-01 00:00:00.999999 UTC + * + * The values may be: + * + * - Integers, as above. + * - Numerics convertible to integers: + * + * Time.utc(Float(0.0), Rational(1, 1), 1.0, 0.0, 0.0, 0.0, 0.0) + * # => 0000-01-01 00:00:00 UTC + * + * - \String integers: + * + * a = %w[0 1 1 0 0 0 0 0] + * # => ["0", "1", "1", "0", "0", "0", "0", "0"] + * Time.utc(*a) # => 0000-01-01 00:00:00 UTC + * + * When exactly ten arguments are given, + * the arguments are interpreted as in the second calling sequence above: + * + * Time.utc(sec, min, hour, mday, month, year, dummy, dummy, dummy, dummy) + * + * where the +dummy+ arguments are ignored: + * + * a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + * # => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + * Time.utc(*a) # => 0005-04-03 02:01:00 UTC + * + * This form is useful for creating a \Time object from a 10-element + * array returned by Time.to_a: + * + * t = Time.new(2000, 1, 2, 3, 4, 5, 6) # => 2000-01-02 03:04:05 +000006 + * a = t.to_a # => [5, 4, 3, 2, 1, 2000, 0, 2, false, nil] + * Time.utc(*a) # => 2000-01-02 03:04:05 UTC + * + * The two forms have their first six arguments in common, + * though in different orders; + * the ranges of these common arguments are the same for both forms; see above. + * + * Raises an exception if the number of arguments is eight, nine, + * or greater than ten. * * Time.gm is an alias for Time.utc. * @@ -3391,36 +3459,19 @@ time_s_mkutc(int argc, VALUE *argv, VALUE klass) https://github.com/ruby/ruby/blob/trunk/time.c#L3459 /* * call-seq: - * Time.local(year, month = 1, day = 1, hour = 0, min = 0, sec_i = 0, usec = 0) -> new_time - * Time.local(sec, min, hour, day, month, year, dummy, dummy, dummy, dummy) -> new_time - * - * Returns a new \Time object based the on given arguments; - * its timezone is the local timezone. - * - * In the first form (up to seven arguments), argument +year+ is required. - * - * Time.local(2000) # => 2000-01-01 00:00:00 -0600 - * Time.local(0, 1, 2, 3, 4, 5, 6.5) # => 0000-01-02 03:04:05.0000065 -0600 - * - * In the second form, all ten arguments are required, - * though the last four are ignored. - * This form is useful for creating a time from a 10-element array - * such a (... truncated) -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/