1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Include timezones document in timev.rb

Browse Source 
So that it can be referred as a part of the document of `Time`.
This commit is contained in:
Nobuyoshi Nakada 2023-11-26 19:29:17 +09:00
parent c9c1670f7e
commit ae3e9f114c
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/timezones.rdoc → doc/_timezones.rdoc
View File

@ -1,5 +1,3 @@
= Timezones
== Timezone Specifiers == Timezone Specifiers
Certain \Time methods accept arguments that specify timezones: Certain \Time methods accept arguments that specify timezones:
@ -13,11 +11,11 @@ Certain \Time methods accept arguments that specify timezones:
The value given with any of these must be one of the following The value given with any of these must be one of the following
(each detailed below): (each detailed below):
- {Hours/minutes offset}[rdoc-ref:timezones.rdoc@Hours-2FMinutes+Offsets]. - {Hours/minutes offset}[rdoc-ref:Time@Hours-2FMinutes+Offsets].
- {Single-letter offset}[rdoc-ref:timezones.rdoc@Single-Letter+Offsets]. - {Single-letter offset}[rdoc-ref:Time@Single-Letter+Offsets].
- {Integer offset}[rdoc-ref:timezones.rdoc@Integer+Offsets]. - {Integer offset}[rdoc-ref:Time@Integer+Offsets].
- {Timezone object}[rdoc-ref:timezones.rdoc@Timezone+Objects]. - {Timezone object}[rdoc-ref:Time@Timezone+Objects].
- {Timezone name}[rdoc-ref:timezones.rdoc@Timezone+Names]. - {Timezone name}[rdoc-ref:Time@Timezone+Names].
=== Hours/Minutes Offsets === Hours/Minutes Offsets

4
time.c
View File

@ -4075,7 +4075,7 @@ time_zonelocal(VALUE time, VALUE off)
* t.localtime("-09:00") # => 2000-01-01 11:15:01 -0900 * t.localtime("-09:00") # => 2000-01-01 11:15:01 -0900
* *
* For forms of argument +zone+, see * For forms of argument +zone+, see
* {Timezone Specifiers}[rdoc-ref:timezones.rdoc]. * {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers].
* *
*/ */
@ -4176,7 +4176,7 @@ time_fixoff(VALUE time)
* t.getlocal('+12:00') # => 2000-01-01 12:00:00 +1200 * t.getlocal('+12:00') # => 2000-01-01 12:00:00 +1200
* *
* For forms of argument +zone+, see * For forms of argument +zone+, see
* {Timezone Specifiers}[rdoc-ref:timezones.rdoc]. * {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers].
* *
*/ */

12
timev.rb
View File

@ -66,7 +66,7 @@
# #
# Time.new(2002, 10, 31, 2, 2, 2, "+02:00") #=> 2002-10-31 02:02:02 +0200 # Time.new(2002, 10, 31, 2, 2, 2, "+02:00") #=> 2002-10-31 02:02:02 +0200
# #
# Or {a timezone object}[rdoc-ref:timezones.rdoc@Timezone+Objects]: # Or {a timezone object}[rdoc-ref:Time@Timezone+Objects]:
# #
# zone = timezone("Europe/Athens") # Eastern European Time, UTC+2 # zone = timezone("Europe/Athens") # Eastern European Time, UTC+2
# Time.new(2002, 10, 31, 2, 2, 2, zone) #=> 2002-10-31 02:02:02 +0200 # Time.new(2002, 10, 31, 2, 2, 2, zone) #=> 2002-10-31 02:02:02 +0200
@ -210,7 +210,9 @@
# - #floor: Returns a new time with subseconds lowered to a floor. # - #floor: Returns a new time with subseconds lowered to a floor.
# #
# For the forms of argument +zone+, see # For the forms of argument +zone+, see
# {Timezone Specifiers}[rdoc-ref:timezones.rdoc]. # {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers].
#
# :include: doc/_timezones.rdoc
class Time class Time
# Creates a new \Time object from the current system time. # Creates a new \Time object from the current system time.
# This is the same as Time.new without arguments. # This is the same as Time.new without arguments.
@ -219,7 +221,7 @@ class Time
# Time.now(in: '+04:00') # => 2009-06-24 07:39:54 +0400 # Time.now(in: '+04:00') # => 2009-06-24 07:39:54 +0400
# #
# For forms of argument +zone+, see # For forms of argument +zone+, see
# {Timezone Specifiers}[rdoc-ref:timezones.rdoc]. # {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers].
def self.now(in: nil) def self.now(in: nil)
Primitive.time_s_now(Primitive.arg!(:in)) Primitive.time_s_now(Primitive.arg!(:in))
end end
@ -277,7 +279,7 @@ class Time
# Time.at(secs, in: '-12:00') # => 2000-12-31 17:59:59 -1200 # Time.at(secs, in: '-12:00') # => 2000-12-31 17:59:59 -1200
# #
# For the forms of argument +zone+, see # For the forms of argument +zone+, see
# {Timezone Specifiers}[rdoc-ref:timezones.rdoc]. # {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers].
# #
def self.at(time, subsec = false, unit = :microsecond, in: nil) def self.at(time, subsec = false, unit = :microsecond, in: nil)
if Primitive.mandatory_only? if Primitive.mandatory_only?
@ -371,7 +373,7 @@ class Time
# When positional argument +zone+ or keyword argument +in:+ is given, # When positional argument +zone+ or keyword argument +in:+ is given,
# the new \Time object is in the specified timezone. # the new \Time object is in the specified timezone.
# For the forms of argument +zone+, see # For the forms of argument +zone+, see
# {Timezone Specifiers}[rdoc-ref:timezones.rdoc]: # {Timezone Specifiers}[rdoc-ref:Time@Timezone+Specifiers]:
# #
# Time.new(2000, 1, 1, 0, 0, 0, '+12:00') # Time.new(2000, 1, 1, 0, 0, 0, '+12:00')
# # => 2000-01-01 00:00:00 +1200 # # => 2000-01-01 00:00:00 +1200