aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support
diff options
context:
space:
mode:
authorXavier Noria <fxn@hashref.com>2013-04-26 01:49:06 -0700
committerXavier Noria <fxn@hashref.com>2013-04-26 01:49:06 -0700
commit11e23b9561b9a7dc0a7b79e6575f56c36e63acc0 (patch)
tree1f7896a2e24c408aff35ed796d795c182acbee2f /activesupport/lib/active_support
parent23b6e9d85d4a57ab0a24ae5e03965ff6c8de5bca (diff)
parente33dd308c9ef395d812c27ec16955bf0d04736c5 (diff)
downloadrails-11e23b9561b9a7dc0a7b79e6575f56c36e63acc0.tar.gz
rails-11e23b9561b9a7dc0a7b79e6575f56c36e63acc0.tar.bz2
rails-11e23b9561b9a7dc0a7b79e6575f56c36e63acc0.zip
Merge pull request #10351 from JonRowe/update_as_date_next_week_to_document_intent
Propose better documentation for ActiveSupports `next_week` functionaility
Diffstat (limited to 'activesupport/lib/active_support')
-rw-r--r--activesupport/lib/active_support/core_ext/date_and_time/calculations.rb10
1 files changed, 5 insertions, 5 deletions
diff --git a/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb b/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
index 5b89ace66b..0d14cba7cc 100644
--- a/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
+++ b/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
@@ -109,11 +109,11 @@ module DateAndTime
alias :at_beginning_of_year :beginning_of_year
# Returns a new date/time representing the given day in the next week.
- # Week is assumed to start on +start_day+, default is
- # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
- # DateTime objects have their time set to 0:00.
- def next_week(start_day = Date.beginning_of_week)
- first_hour{ weeks_since(1).beginning_of_week.days_since(days_span(start_day)) }
+ # The +given_day_in_next_week+ defaults to the beginning of the week
+ # which is determined by +Date.beginning_of_week+ or +config.beginning_of_week+
+ # when set. +DateTime+ objects have their time set to 0:00.
+ def next_week(given_day_in_next_week = Date.beginning_of_week)
+ first_hour{ weeks_since(1).beginning_of_week.days_since(days_span(given_day_in_next_week)) }
end
# Short-hand for months_since(1).