Add documentation for the TimeWithZone#dst? method.

[ci skip]
rails · Jan 1, 2013 · 6d5385a · 6d5385a
1 parent 3511e3f
commit 6d5385a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/activesupport/lib/active_support/time_with_zone.rb b/activesupport/lib/active_support/time_with_zone.rb
@@ -80,6 +80,12 @@ def localtime
     end
     alias_method :getlocal, :localtime
 
+    # Returns true if the the current time is within Daylight Savings Time for the
+    # specified time zone.
+    #
+    #    Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
+    #    Time.zone.parse("2012-5-30").dst?           # => true
+    #    Time.zone.parse("2012-11-30").dst?          # => false
     def dst?
       period.dst?
     end