From a0b46b5f1b8b554f438dd4efcbd71274c34a5dae Mon Sep 17 00:00:00 2001
From: Francesco Rodriguez <lrodriguezsanc@gmail.com>
Date: Fri, 11 May 2012 17:30:46 -0500
Subject: added docs to String#to_datetime

---
 activesupport/lib/active_support/core_ext/string/conversions.rb | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'activesupport')

diff --git a/activesupport/lib/active_support/core_ext/string/conversions.rb b/activesupport/lib/active_support/core_ext/string/conversions.rb
index c42163a2f0..050eea33ee 100644
--- a/activesupport/lib/active_support/core_ext/string/conversions.rb
+++ b/activesupport/lib/active_support/core_ext/string/conversions.rb
@@ -29,6 +29,12 @@ class String
     end
   end
 
+  # Converts a string to a DateTime value.
+  #
+  #   "1-1-2012".to_datetime            #=> Sun, 01 Jan 2012 00:00:00 +0000
+  #   "01/01/2012 23:59:59".to_datetime #=> Sun, 01 Jan 2012 23:59:59 +0000
+  #   "2012-12-13 12:50".to_datetime    #=> Thu, 13 Dec 2012 12:50:00 +0000
+  #   "12/13/2012".to_datetime          #=> ArgumentError: invalid date
   def to_datetime
     unless blank?
       date_values = ::Date._parse(self, false).
-- 
cgit v1.2.3