aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source
diff options
context:
space:
mode:
authorRafael França <rafaelmfranca@gmail.com>2017-10-24 13:28:04 -0400
committerGitHub <noreply@github.com>2017-10-24 13:28:04 -0400
commit453ab1758bd57b971f3ecc9f173198e8fac38e1c (patch)
tree84e45f5c9f3fd48b76ba18ea22e0773a62cf3fa8 /guides/source
parent4aac0bf66c1d18c23f2096d9a343dbf9a95cbf23 (diff)
parentd86370252ea33c5b6fba2d53efa15b1d0082a487 (diff)
downloadrails-453ab1758bd57b971f3ecc9f173198e8fac38e1c.tar.gz
rails-453ab1758bd57b971f3ecc9f173198e8fac38e1c.tar.bz2
rails-453ab1758bd57b971f3ecc9f173198e8fac38e1c.zip
Merge pull request #30972 from jcmfernandes/update-core_ext-time-documentation
Make clear that Time core extensions are split between Numeric and Integer
Diffstat (limited to 'guides/source')
-rw-r--r--guides/source/active_support_core_extensions.md34
1 files changed, 29 insertions, 5 deletions
diff --git a/guides/source/active_support_core_extensions.md b/guides/source/active_support_core_extensions.md
index 067a7b7cb6..54d3dec1c2 100644
--- a/guides/source/active_support_core_extensions.md
+++ b/guides/source/active_support_core_extensions.md
@@ -1796,7 +1796,7 @@ NOTE: Defined in `active_support/core_ext/numeric/bytes.rb`.
### Time
-Enables the use of time calculations and declarations, like `45.minutes + 2.hours + 4.years`.
+Enables the use of time calculations and declarations, like `45.minutes + 2.hours + 4.weeks`.
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:
@@ -1805,13 +1805,15 @@ as well as adding or subtracting their results from a Time object. For example:
# equivalent to Time.current.advance(months: 1)
1.month.from_now
-# equivalent to Time.current.advance(years: 2)
-2.years.from_now
+# equivalent to Time.current.advance(weeks: 2)
+2.weeks.from_now
-# equivalent to Time.current.advance(months: 4, years: 5)
-(4.months + 5.years).from_now
+# equivalent to Time.current.advance(months: 4, weeks: 5)
+(4.months + 5.weeks).from_now
```
+WARNING. For other durations please refer to the time extensions to `Integer`.
+
NOTE: Defined in `active_support/core_ext/numeric/time.rb`.
### Formatting
@@ -1947,6 +1949,28 @@ The method `ordinalize` returns the ordinal string corresponding to the receiver
NOTE: Defined in `active_support/core_ext/integer/inflections.rb`.
+### Time
+
+Enables the use of time calculations and declarations, like `4.months + 5.years`.
+
+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:
+
+```ruby
+# equivalent to Time.current.advance(months: 1)
+1.month.from_now
+
+# equivalent to Time.current.advance(years: 2)
+2.years.from_now
+
+# equivalent to Time.current.advance(months: 4, years: 5)
+(4.months + 5.years).from_now
+```
+
+WARNING. For other durations please refer to the time extensions to `Numeric`.
+
+NOTE: Defined in `active_support/core_ext/integer/time.rb`.
+
Extensions to `BigDecimal`
--------------------------
### `to_s`