summaryrefslogtreecommitdiff
path: root/time.c
diff options
context:
space:
mode:
authorJeremy Evans <code@jeremyevans.net>2019-07-29 11:03:32 -0700
committerJeremy Evans <code@jeremyevans.net>2019-07-29 11:06:43 -0700
commit177731aadf0d2b2fb293e221728252c73446235a (patch)
tree52a27a81e14f6174e729dee162d45de24c7e4d8b /time.c
parent9170646f130be8a66bd1ea84a7bed59a353afd12 (diff)
Document that Timezone argument for Time uses dst? if available [ci skip]
Diffstat (limited to 'time.c')
-rw-r--r--time.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/time.c b/time.c
index ed7928848c..7f39799bed 100644
--- a/time.c
+++ b/time.c
@@ -5703,7 +5703,7 @@ rb_time_zone_abbreviation(VALUE zone, VALUE time)
* == Timezone argument
*
* A timezone argument must have +local_to_utc+ and +utc_to_local+
- * methods, and may have +name+ and +abbr+ methods.
+ * methods, and may have +name+, +abbr+, and +dst?+ methods.
*
* The +local_to_utc+ method should convert a Time-like object from
* the timezone to UTC, and +utc_to_local+ is the opposite. The
@@ -5722,6 +5722,9 @@ rb_time_zone_abbreviation(VALUE zone, VALUE time)
*
* The +abbr+ method is used by '%Z' in #strftime.
*
+ * The +dst?+ method is called with a +Time+ value and should return whether
+ * the +Time+ value is in daylight savings time in the zone.
+ *
* === Auto conversion to Timezone
*
* At loading marshaled data, a timezone name will be converted to a timezone