diff options
author | bogdanvlviv <bogdanvlviv@gmail.com> | 2017-10-24 21:03:35 +0000 |
---|---|---|
committer | bogdanvlviv <bogdanvlviv@gmail.com> | 2017-10-24 21:06:12 +0000 |
commit | 08a177ee63c74fde62426c6af5fda18488747de9 (patch) | |
tree | 44541da953efa3cce7f69f7dcd7c2278be00b157 /activesupport/lib/active_support/core_ext/numeric/time.rb | |
parent | 453ab1758bd57b971f3ecc9f173198e8fac38e1c (diff) | |
download | rails-08a177ee63c74fde62426c6af5fda18488747de9.tar.gz rails-08a177ee63c74fde62426c6af5fda18488747de9.tar.bz2 rails-08a177ee63c74fde62426c6af5fda18488747de9.zip |
Simplify API documentation of methods that return a Duration
Related to #30972
Diffstat (limited to 'activesupport/lib/active_support/core_ext/numeric/time.rb')
-rw-r--r-- | activesupport/lib/active_support/core_ext/numeric/time.rb | 22 |
1 files changed, 5 insertions, 17 deletions
diff --git a/activesupport/lib/active_support/core_ext/numeric/time.rb b/activesupport/lib/active_support/core_ext/numeric/time.rb index dee9141356..bc4627f7a2 100644 --- a/activesupport/lib/active_support/core_ext/numeric/time.rb +++ b/activesupport/lib/active_support/core_ext/numeric/time.rb @@ -7,21 +7,9 @@ require "active_support/core_ext/date/calculations" require "active_support/core_ext/date/acts_like" class Numeric - # Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.weeks. + # Returns a Duration instance matching the number of seconds provided. # - # These methods use Time#advance for precise date calculations when using from_now, ago, etc. - # as well as adding or subtracting their results from a Time object. For example: - # - # # equivalent to Time.current.advance(days: 1) - # 1.month.from_now - # - # # equivalent to Time.current.advance(weeks: 2) - # 2.weeks.from_now - # - # # equivalent to Time.current.advance(days: 4, weeks: 5) - # (4.days + 5.weeks).from_now - # - # For other durations, check the extensions to Integer. + # 2.seconds # => 2 seconds def seconds ActiveSupport::Duration.seconds(self) end @@ -68,10 +56,10 @@ class Numeric alias :fortnight :fortnights # Returns the number of milliseconds equivalent to the seconds provided. - # Used with the standard time durations, like 1.hour.in_milliseconds -- - # so we can feed them to JavaScript functions like getTime(). + # Used with the standard time durations. # - # 2.in_milliseconds # => 2_000 + # 2.in_milliseconds # => 2000 + # 1.hour.in_milliseconds # => 3600000 def in_milliseconds self * 1000 end |