Merge pull request #20549 from maurogeorge/distance_of_time_in_words-rdoc

Add RDoc about scope option on distance_of_time_in_words

1 files changed, 20 insertions, 0 deletions

diff --git a/actionview/lib/action_view/helpers/date_helper.rb b/actionview/lib/action_view/helpers/date_helper.rb
index 394e20ff2b..813eda08a3 100644
--- a/actionview/lib/action_view/helpers/date_helper.rb
+++ b/actionview/lib/action_view/helpers/date_helper.rb
@@ -68,6 +68,26 @@ module ActionView
       #   distance_of_time_in_words(from_time, to_time, include_seconds: true)                        # => about 6 years
       #   distance_of_time_in_words(to_time, from_time, include_seconds: true)                        # => about 6 years
       #   distance_of_time_in_words(Time.now, Time.now)                                               # => less than a minute
+      #
+      # With the <tt>scope</tt> you can define a custom scope for Rails lookup
+      # the translation.
+      # For example you can define the following in your locale (e.g. en.yml).
+      #
+      #   datetime:
+      #     distance_in_words:
+      #       short:
+      #         about_x_hours:
+      #           one: 1 hr
+      #           other: '%{count} hr'
+      #
+      # See https://github.com/svenfuchs/rails-i18n/blob/master/rails/locale/en.yml
+      # for more examples.
+      #
+      # Which then will result in the following:
+      #
+      #   from_time = Time.now
+      #   distance_of_time_in_words(from_time, from_time + 50.minutes, scope: 'datetime.distance_in_words.short') # => 1 hr
+      #   distance_of_time_in_words(from_time, from_time + 3.hours, scope: 'datetime.distance_in_words.short')    # => 3 hr
       def distance_of_time_in_words(from_time, to_time = 0, options = {})
         options = {
           scope: :'datetime.distance_in_words'