From 0c0875fe6050a79e5525a71f6819168bd4947ff8 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@ruby-lang.org>
Date: Fri, 24 Nov 2023 19:37:54 +0900
Subject: [PATCH] [DOC] Mention `Time.find_timezone` method

---
 doc/timezones.rdoc | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/doc/timezones.rdoc b/doc/timezones.rdoc
index 949e0f65c1..d59efba37d 100644
--- a/doc/timezones.rdoc
+++ b/doc/timezones.rdoc
@@ -17,6 +17,7 @@ The value given with any of these must be one of the following
 - {Single-letter offset}[rdoc-ref:timezones.rdoc@Single-Letter+Offsets].
 - {Integer offset}[rdoc-ref:timezones.rdoc@Integer+Offsets].
 - {Timezone object}[rdoc-ref:timezones.rdoc@Timezone+Objects].
+- {Timezone name}[rdoc-ref:timezones.rdoc@Timezone+Names].
 
 === Hours/Minutes Offsets
 
@@ -102,3 +103,29 @@ which will be called if defined:
   - Called when <tt>Marshal.dump(t)</tt> is invoked
   - Argument: none.
   - Returns: the string name of the timezone.
+
+=== Timezone Names
+
+If the class (the receiver of class methods, or the class of the receiver
+of instance methods) has `find_timezone` singleton method, this method is
+called to achieve the corresponding timezone object from a timezone name.
+
+For example, using {Timezone}[https://github.com/panthomakos/timezone]:
+    class TimeWithTimezone < Time
+      require 'timezone'
+      def self.find_timezone(z) = Timezone[z]
+    end
+
+    TimeWithTimezone.now(in: "America/New_York")        #=> 2023-12-25 00:00:00 -0500
+    TimeWithTimezone.new("2023-12-25 America/New_York") #=> 2023-12-25 00:00:00 -0500
+
+Or, using {TZInfo}[https://tzinfo.github.io]:
+    class TimeWithTZInfo < Time
+      require 'tzinfo'
+      def self.find_timezone(z) = TZInfo::Timezone.get(z)
+    end
+
+    TimeWithTZInfo.now(in: "America/New_York")          #=> 2023-12-25 00:00:00 -0500
+    TimeWithTZInfo.new("2023-12-25 America/New_York")   #=> 2023-12-25 00:00:00 -0500
+
+You can define this method per subclasses, or on the toplevel `Time` class.