summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorप्रथमेश Sonpatki <csonpatki@gmail.com>2020-02-27 02:08:49 (GMT)
committerGitHub <noreply@github.com>2020-02-27 02:08:49 (GMT)
commit9a422fc010ab150438ef9dd66fd4c717f03927d9 (patch)
tree47bba752ddfa255a237b2069d7745ef5560449c9
parent18674aef0d8199958dbda21eff5167dfc4a5de9a (diff)
Update docs for Time#at method [ci skip]
Add docs about all possible options for the `in` argument.
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/2929 Merged-By: nobu <nobu@ruby-lang.org>
-rw-r--r--time.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/time.c b/time.c
index 2b5d451..e5e71e5 100644
--- a/time.c
+++ b/time.c
@@ -2806,10 +2806,12 @@ get_scale(VALUE unit)
* +seconds+ and +microseconds_with_frac+ since the Epoch.
* +seconds_with_frac+ and +microseconds_with_frac+
* can be an Integer, Float, Rational, or other Numeric.
- * non-portable feature allows the offset to be negative on some systems.
+ * A non-portable feature allows the offset to be negative on some systems.
*
* If +in+ argument is given, the result is in that timezone or UTC offset, or
* if a numeric argument is given, the result is in local time.
+ * The +in+ argument accepts timezones in +HH:MM or -HH:MM format along with
+ * accepting military timezones and UTC.
*
* Time.at(0) #=> 1969-12-31 18:00:00 -0600
* Time.at(Time.at(0)) #=> 1969-12-31 18:00:00 -0600
@@ -2818,6 +2820,9 @@ get_scale(VALUE unit)
* Time.at(946684800.2).usec #=> 200000
* Time.at(946684800, 123456.789).nsec #=> 123456789
* Time.at(946684800, 123456789, :nsec).nsec #=> 123456789
+ * Time.at(1582721899, in: "+09:00") #=> 2020-02-26 21:58:19 +0900
+ * Time.at(1582721899, in: "UTC") #=> 2020-02-26 12:58:19 UTC
+ * Time.at(1582721899, in: "C") #=> 2020-02-26 13:58:19 +0300
*/
static VALUE