Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Duration#to_i for clarification #19473

Merged
merged 1 commit into from
Mar 23, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions activesupport/lib/active_support/duration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,30 @@ def to_s
@value.to_s
end

# Returns the number of seconds that this Duration represents.
#
# 1.minute.to_i # => 60
# 1.hour.to_i # => 3600
# 1.day.to_i # => 86400
#
# Note that this conversion makes some assumptions about the
# duration of some periods, e.g. months are always 30 days
# and years are 365.25 days:
#
# # equivalent to 30.days.to_i
# 1.month.to_i # => 2592000
#
# # equivalent to 365.25.days.to_i
# 1.year.to_i # => 31557600
#
# In such cases, Ruby's core
# Date[http://ruby-doc.org/stdlib/libdoc/date/rdoc/Date.html] and
# Time[http://ruby-doc.org/stdlib/libdoc/time/rdoc/Time.html] should be used for precision
# date and time arithmetic.
def to_i
@value.to_i
end

# Returns +true+ if +other+ is also a Duration instance, which has the
# same parts as this one.
def eql?(other)
Expand Down