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

[DOC] Fix wording in descriptions of Time-like objects

Browse Source 
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
This commit is contained in:
Nobuyoshi Nakada 2023-12-05 18:10:56 +09:00
parent bf0f56e124
commit bf0c8055ab
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/_timezones.rdoc
View File

@ -66,8 +66,8 @@ The timezone methods are:
- Called when Time.new is invoked with +tz+ - Called when Time.new is invoked with +tz+
as the value of positional argument +zone+ or keyword argument +in:+. as the value of positional argument +zone+ or keyword argument +in:+.
- Argument: a {Time-like object}[rdoc-ref:Time@Time-like+Objects]. - Argument: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects].
- Returns: a {Time-like object}[rdoc-ref:Time@Time-like+Objects] in the UTC timezone. - Returns: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects] in the UTC timezone.
- +utc_to_local+: - +utc_to_local+:
@ -75,8 +75,8 @@ The timezone methods are:
as the value for keyword argument +in:+, as the value for keyword argument +in:+,
and when Time#getlocal or Time#localtime is called with +tz+ and when Time#getlocal or Time#localtime is called with +tz+
as the value for positional argument +zone+. as the value for positional argument +zone+.
- Argument: a {Time-like object}[rdoc-ref:Time@Time-like+Objects]. - Argument: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects].
- Returns: a {Time-like object}[rdoc-ref:Time@Time-like+Objects] in the local timezone. - Returns: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects] in the local timezone.
A custom timezone class may have these instance methods, A custom timezone class may have these instance methods,
which will be called if defined: which will be called if defined:
@ -84,7 +84,7 @@ which will be called if defined:
- +abbr+: - +abbr+:
- Called when Time#strftime is invoked with a format involving <tt>%Z</tt>. - Called when Time#strftime is invoked with a format involving <tt>%Z</tt>.
- Argument: a {Time-like object}[rdoc-ref:Time@Time-like+Objects]. - Argument: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects].
- Returns: a string abbreviation for the timezone name. - Returns: a string abbreviation for the timezone name.
- +dst?+: - +dst?+:
@ -93,7 +93,7 @@ which will be called if defined:
as the value for keyword argument +in:+, as the value for keyword argument +in:+,
and when Time#getlocal or Time#localtime is called with +tz+ and when Time#getlocal or Time#localtime is called with +tz+
as the value for positional argument +zone+. as the value for positional argument +zone+.
- Argument: a {Time-like object}[rdoc-ref:Time@Time-like+Objects]. - Argument: a {Time-like object}[rdoc-ref:Time@Time-Like+Objects].
- Returns: whether the time is daylight saving time. - Returns: whether the time is daylight saving time.
- +name+: - +name+:
@ -102,19 +102,20 @@ which will be called if defined:
- Argument: none. - Argument: none.
- Returns: the string name of the timezone. - Returns: the string name of the timezone.
==== +Time+-like Objects ==== +Time+-Like Objects
A +Time+-like object means a container object to interface with A +Time+-like object is a container object capable of interfacing with
timezone libraries for timezone conversion. timezone libraries for timezone conversion.
An argument object to the timezone conversion methods above will have The argument to the timezone conversion methods above will have attributes
attributes similar to Time, except for that timezone related attributes similar to Time, except that timezone related attributes are meaningless.
are meaningless.
The objects returned by +local_to_utc+ and +utc_to_local+ methods of the The objects returned by +local_to_utc+ and +utc_to_local+ methods of the
timezone object may be of the same class as their arguments, arbitrary timezone object may be of the same class as their arguments, of arbitrary
object classes, or Integer class. The others than +Integer+ just must object classes, or of class Integer.
have the following attributes:
For a returned class other than +Integer+, the class must have the
following methods:
- +year+ - +year+
- +mon+ - +mon+
@ -125,8 +126,8 @@ have the following attributes:
- +isdst+ - +isdst+
- +to_i+ - +to_i+
In the case an +Integer+ is returned, its components, decomposed in UTC, For a returned +Integer+, its components, decomposed in UTC, are
are interpreted as times in the specified timezone. interpreted as times in the specified timezone.
=== Timezone Names === Timezone Names