diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-08-21 11:36:36 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-21 11:36:36 -0500 |
commit | 936327a51915d6a39086f65ea1b8e5c5c4ade78f (patch) | |
tree | 85a95347dd61199f02578ecdc448a775a0f1e048 /time.c | |
parent | b043dd9c5dd7b5c46580e49ad38b49d5cb5beaf1 (diff) | |
download | ruby-936327a51915d6a39086f65ea1b8e5c5c4ade78f.tar.gz |
[DOC] Enhanced RDoc for Time (#6255)
Treats:
#utc
#hash
#localtime
Diffstat (limited to 'time.c')
-rw-r--r-- | time.c | 60 |
1 files changed, 31 insertions, 29 deletions
@@ -3486,7 +3486,7 @@ time_to_f(VALUE time) /* * call-seq: - * time.to_r -> rational + * to_r -> rational * * Returns the value of +self+ as a Rational number of seconds * since the Epoch, which is exact: @@ -3540,7 +3540,7 @@ time_usec(VALUE time) /* * call-seq: - * time.nsec -> integer + * nsec -> integer * * Returns the number of nanoseconds in the subseconds part of +self+ * in the range (0..999_999_999); @@ -3659,20 +3659,20 @@ time_eql(VALUE time1, VALUE time2) /* * call-seq: - * time.utc? -> true or false - * time.gmt? -> true or false + * utc? -> true or false * - * Returns +true+ if _time_ represents a time in UTC (GMT). + * Returns +true+ if +self+ represents a time in UTC (GMT): * - * t = Time.now #=> 2007-11-19 08:15:23 -0600 - * t.utc? #=> false - * t = Time.gm(2000,"jan",1,20,15,1) #=> 2000-01-01 20:15:01 UTC - * t.utc? #=> true + * now = Time.now + * # => 2022-08-18 10:24:13.5398485 -0500 + * now.utc? # => false + * utc = Time.utc(2000, 1, 1, 20, 15, 1) + * # => 2000-01-01 20:15:01 UTC + * utc.utc? # => true * - * t = Time.now #=> 2007-11-19 08:16:03 -0600 - * t.gmt? #=> false - * t = Time.gm(2000,1,1,20,15,1) #=> 2000-01-01 20:15:01 UTC - * t.gmt? #=> true + * Time#gmt? is an alias for Time#utc?. + * + * Related: Time.utc. */ static VALUE @@ -3686,11 +3686,11 @@ time_utc_p(VALUE time) /* * call-seq: - * time.hash -> integer + * hash -> integer * - * Returns a hash code for this Time object. + * Returns the integer hash code for +self+. * - * See also Object#hash. + * Related: Object#hash. */ static VALUE @@ -3777,25 +3777,27 @@ time_zonelocal(VALUE time, VALUE off) /* * call-seq: - * time.localtime -> time - * time.localtime(utc_offset) -> time + * localtime -> self or new_time + * localtime(zone) -> new_time * - * Converts _time_ to local time (using the local time zone in - * effect at the creation time of _time_) modifying the receiver. + * With no argument given: * - * If +utc_offset+ is given, it is used instead of the local time. + * - Returns +self+ if +self+ is a local time. + * - Otherwise returns a new \Time in the user's local timezone: + * + * t = Time.utc(2000, 1, 1, 20, 15, 1) # => 2000-01-01 20:15:01 UTC + * t.localtime # => 2000-01-01 14:15:01 -0600 * - * t = Time.utc(2000, "jan", 1, 20, 15, 1) #=> 2000-01-01 20:15:01 UTC - * t.utc? #=> true + * With argument +zone+ given, + * returns the new \Time object created by converting + * +self+ to the given time zone: * - * t.localtime #=> 2000-01-01 14:15:01 -0600 - * t.utc? #=> false + * t = Time.utc(2000, 1, 1, 20, 15, 1) # => 2000-01-01 20:15:01 UTC + * t.localtime("-09:00") # => 2000-01-01 11:15:01 -0900 * - * t.localtime("+09:00") #=> 2000-01-02 05:15:01 +0900 - * t.utc? #=> false + * For forms of argument +zone+, see + * {Timezone Specifiers}[rdoc-ref:doc/timezone_specifiers.rdoc]. * - * If +utc_offset+ is not given and _time_ is local time, just returns - * the receiver. */ static VALUE |