From feaa02ab6d64ac856e9c7774950a0b79df3138d2 Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <progval+git@progval.net>
Date: Mon, 8 Nov 2021 23:20:28 +0100
Subject: [PATCH] Add docstring to supybot.utils.time.iana_timezone

---
 src/utils/time.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/utils/time.py b/src/utils/time.py
index 9739b69a3..7b66a3a57 100644
--- a/src/utils/time.py
+++ b/src/utils/time.py
@@ -53,6 +53,14 @@ class UnknownTimeZone(TimezoneException):
     pass
 
 def iana_timezone(name):
+    """Returns a :class:datetime.tzinfo object, given an IANA timezone name,
+    eg. ``"Europe/Paris"``.
+
+    This uses :class:``zoneinfo.ZoneInfo`` if available,
+    :func:``pytz.timezone`` otherwise.
+
+    May raise instances of :exc:`TimezoneException`.
+    """
     if not _IANA_TZ_RE.match(name):
         raise UnknownTimeZone(name)