added docs to String#to_date

rails · May 11, 2012 · 53cc85f · 53cc85f
1 parent 7bf6edf
commit 53cc85f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/activesupport/lib/active_support/core_ext/string/conversions.rb b/activesupport/lib/active_support/core_ext/string/conversions.rb
@@ -15,6 +15,12 @@ def to_time(form = :utc)
     end
   end
 
+  # Converts a string to a Date value.
+  #
+  #   "1-1-2012".to_date   #=> Sun, 01 Jan 2012  
+  #   "01/01/2012".to_date #=> Sun, 01 Jan 2012  
+  #   "2012-12-13".to_date #=> Thu, 13 Dec 2012  
+  #   "12/13/2012".to_date #=> ArgumentError: invalid date
   def to_date
     unless blank?
       date_values = ::Date._parse(self, false).values_at(:year, :mon, :mday)