diff options
author | gregolsen <anotheroneman@yahoo.com> | 2011-11-07 13:26:56 +0200 |
---|---|---|
committer | Xavier Noria <fxn@hashref.com> | 2011-11-25 12:02:49 -0800 |
commit | 7a33a005d732e80f5a6832b67df6dec5a6faaa1e (patch) | |
tree | 901e1460ba2f48f1010c8f2f699f95072e2244bf /activesupport/lib/active_support/core_ext/date | |
parent | 3f1a4c3415113f2d365eb1a5531757699afec605 (diff) | |
download | rails-7a33a005d732e80f5a6832b67df6dec5a6faaa1e.tar.gz rails-7a33a005d732e80f5a6832b67df6dec5a6faaa1e.tar.bz2 rails-7a33a005d732e80f5a6832b67df6dec5a6faaa1e.zip |
API docstrings updated with default value info
Diffstat (limited to 'activesupport/lib/active_support/core_ext/date')
-rw-r--r-- | activesupport/lib/active_support/core_ext/date/calculations.rb | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/activesupport/lib/active_support/core_ext/date/calculations.rb b/activesupport/lib/active_support/core_ext/date/calculations.rb index a322075c4e..ea9a1c2c0d 100644 --- a/activesupport/lib/active_support/core_ext/date/calculations.rb +++ b/activesupport/lib/active_support/core_ext/date/calculations.rb @@ -174,7 +174,7 @@ class Date months_since(1) end unless method_defined?(:next_month) - # Returns number of days to start of this week, week starts on start_day (default is Monday) + # Returns number of days to start of this week, week starts on start_day (default is :monday). def days_to_week_start(start_day = :monday) start_day_number = DAYS_INTO_WEEK[start_day] current_day_number = wday != 0 ? wday - 1 : 6 @@ -182,7 +182,7 @@ class Date days_span >= 0 ? days_span : 7 + days_span end - # Returns a new Date/DateTime representing the "start" of this week, week starts on start_day (i.e, Monday; DateTime objects will have time set to 0:00). + # Returns a new Date/DateTime representing the "start" of this week, week starts on start_day (default is :monday, i.e. Monday; DateTime objects will have time set to 0:00). def beginning_of_week(start_day = :monday) days_to_start = days_to_week_start(start_day) result = self - days_to_start @@ -191,7 +191,7 @@ class Date alias :monday :beginning_of_week alias :at_beginning_of_week :beginning_of_week - # Returns a new Date/DateTime representing the end of this week, week starts on start_day (Sunday, DateTime objects will have time set to 23:59:59). + # Returns a new Date/DateTime representing the end of this week, week starts on start_day (default is :monday, i.e. Sunday, DateTime objects will have time set to 23:59:59). def end_of_week(start_day = :monday) days_to_end = 6 - days_to_week_start(start_day) result = self + days_to_end.days |