From 7a33a005d732e80f5a6832b67df6dec5a6faaa1e Mon Sep 17 00:00:00 2001 From: gregolsen Date: Mon, 7 Nov 2011 13:26:56 +0200 Subject: API docstrings updated with default value info --- activesupport/lib/active_support/core_ext/date/calculations.rb | 6 +++--- activesupport/lib/active_support/core_ext/time/calculations.rb | 6 +++--- 2 files changed, 6 insertions(+), 6 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 diff --git a/activesupport/lib/active_support/core_ext/time/calculations.rb b/activesupport/lib/active_support/core_ext/time/calculations.rb index 154ba78646..2cc5c82265 100644 --- a/activesupport/lib/active_support/core_ext/time/calculations.rb +++ b/activesupport/lib/active_support/core_ext/time/calculations.rb @@ -161,7 +161,7 @@ class Time months_since(1) end - # 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 @@ -169,7 +169,7 @@ class Time days_span >= 0 ? days_span : 7 + days_span end - # Returns a new Time representing the "start" of this week, week starts on start_day (deafult is Monday, e.g. Monday, 0:00) + # Returns a new Time representing the "start" of this week, week starts on start_day (default is :monday, i.e. Monday, 0:00). def beginning_of_week(start_day = :monday) days_to_start = days_to_week_start(start_day) (self - days_to_start.days).midnight @@ -177,7 +177,7 @@ class Time alias :monday :beginning_of_week alias :at_beginning_of_week :beginning_of_week - # Returns a new Time representing the end of this week, week starts on start_day (deafult is Monday, end of Sunday) + # Returns a new Time representing the end of this week, week starts on start_day (default is :monday, i.e. end of Sunday). def end_of_week(start_day = :monday) days_to_end = 6 - days_to_week_start(start_day) (self + days_to_end.days).end_of_day -- cgit v1.2.3