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/integer/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/integer/time.rb')
-rw-r--r-- | activesupport/lib/active_support/core_ext/integer/time.rb | 21 |
1 files changed, 5 insertions, 16 deletions
diff --git a/activesupport/lib/active_support/core_ext/integer/time.rb b/activesupport/lib/active_support/core_ext/integer/time.rb index 66160b3dd7..5efb89cf9f 100644 --- a/activesupport/lib/active_support/core_ext/integer/time.rb +++ b/activesupport/lib/active_support/core_ext/integer/time.rb @@ -4,28 +4,17 @@ require "active_support/duration" require "active_support/core_ext/numeric/time" class Integer - # Enables the use of time calculations and declarations, like <tt>45.minutes + - # 2.hours + 4.years</tt>. + # Returns a Duration instance matching the number of months provided. # - # These methods use Time#advance for precise date calculations when using - # <tt>from_now</tt>, +ago+, etc. as well as adding or subtracting their - # results from a Time object. - # - # # equivalent to Time.now.advance(months: 1) - # 1.month.from_now - # - # # equivalent to Time.now.advance(years: 2) - # 2.years.from_now - # - # # equivalent to Time.now.advance(months: 4, years: 5) - # (4.months + 5.years).from_now - # - # For other durations, check the extensions to Numeric. + # 2.months # => 2 months def months ActiveSupport::Duration.months(self) end alias :month :months + # Returns a Duration instance matching the number of years provided. + # + # 2.years # => 2 years def years ActiveSupport::Duration.years(self) end |