1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Add RDoc about scope option on distance_of_time_in_words

[ci skip]
This commit is contained in:
Mauro George 2015-06-13 15:47:18 -03:00
parent dfc9269517
commit f6d325eda4

View file

@ -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'