Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
philr committed Oct 27, 2021
1 parent 66a69d9 commit 4c3fec0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions lib/tzinfo/timestamp.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ class Timestamp
private_constant :JD_EPOCH

class << self
# Returns a new {Timestamp} representing the (Gregorian calendar) date and
# time specified by the supplied parameters.
# Returns a new {Timestamp} representing the (proleptic Gregorian
# calendar) date and time specified by the supplied parameters.
#
# If `utc_offset` is `nil`, `:utc` or 0, the date and time parameters will
# be interpreted as representing a UTC date and time. Otherwise the date
Expand All @@ -38,7 +38,7 @@ class << self
# specified offset, an offset from UTC specified as an `Integer` number
# of seconds or the `Symbol` `:utc`).
# @return [Timestamp] a new {Timestamp} representing the specified
# (Gregorian calendar) date and time.
# (proleptic Gregorian calendar) date and time.
# @raise [ArgumentError] if either of `year`, `month`, `day`, `hour`,
# `minute`, or `second` is not an `Integer`.
# @raise [ArgumentError] if `sub_second` is not a `Rational`, or the
Expand Down Expand Up @@ -86,7 +86,7 @@ def create(year, month = 1, day = 1, hour = 0, minute = 0, second = 0, sub_secon
# passed to the block. The block must then return a {Timestamp}, which
# will be converted back to the type of the initial value. If the initial
# value was a {Timestamp}, the block result will be returned. If the
# initial value was a {DateTime}, a Gregorian {DateTime} will be returned.
# initial value was a `DateTime`, a Gregorian `DateTime` will be returned.
#
# The UTC offset of `value` can either be preserved (the {Timestamp}
# representation will have the same UTC offset as `value`), ignored (the
Expand Down Expand Up @@ -400,7 +400,7 @@ def to_time

# Converts this {Timestamp} to a Gregorian `DateTime`.
#
# @return [DateTime] a Gregorian DateTime representation of this
# @return [DateTime] a Gregorian `DateTime` representation of this
# {Timestamp}. If the UTC offset of this {Timestamp} is not specified, a
# UTC `DateTime` will be returned.
def to_datetime
Expand All @@ -410,7 +410,7 @@ def to_datetime
# Converts this {Timestamp} to an `Integer` number of seconds since
# 1970-01-01 00:00:00 UTC (ignoring leap seconds).
#
# @return [Integer] an Integer representation of this {Timestamp} (the
# @return [Integer] an `Integer` representation of this {Timestamp} (the
# number of seconds since 1970-01-01 00:00:00 UTC ignoring leap seconds).
def to_i
value
Expand Down

0 comments on commit 4c3fec0

Please sign in to comment.