Permalink
Browse files

copy edit the time_ago_in_words helper docs

  • Loading branch information...
1 parent 8fbfeb1 commit 6431753851c42346fa49b10d5371d77696cbcf99 @vijaydev vijaydev committed Aug 22, 2012
Showing with 4 additions and 4 deletions.
  1. +4 −4 actionpack/lib/action_view/helpers/date_helper.rb
@@ -139,11 +139,8 @@ def distance_of_time_in_words(from_time, to_time = 0, include_seconds_or_options
# Like <tt>distance_of_time_in_words</tt>, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
#
- # The <tt>from_time</tt> argument must be of type <tt>Time</tt> rather than type <tt>Numeric</tt>. For example,
- # to get the <tt>time_ago_in_words</tt> for 30 minutes you would use <tt>30.minutes.ago</tt> as the argument
- # rather than just <tt>30.minutes</tt>.
- #
# time_ago_in_words(3.minutes.from_now) # => 3 minutes
+ # time_ago_in_words(3.minutes.ago) # => 3 minutes
# time_ago_in_words(Time.now - 15.hours) # => about 15 hours
# time_ago_in_words(Time.now) # => less than a minute
# time_ago_in_words(Time.now, :include_seconds => true) # => less than 5 seconds
@@ -153,6 +150,9 @@ def distance_of_time_in_words(from_time, to_time = 0, include_seconds_or_options
#
# from_time = (3.days + 14.minutes + 25.seconds).ago
# time_ago_in_words(from_time) # => 3 days
+ #
+ # Note that you cannot pass a <tt>Numeric</tt> value to <tt>time_ago_in_words</tt>.
+ #
def time_ago_in_words(from_time, include_seconds_or_options = {})
distance_of_time_in_words(from_time, Time.now, include_seconds_or_options)
end

0 comments on commit 6431753

Please sign in to comment.