From: Michael V. DePalatis <mike@depalatis.net>
Date: Wed, 5 May 2021 15:55:24 +0000 (-0600)
Subject: Update docstring
X-Git-Tag: v6.2.0b1~45^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3025%2Fhead;p=thirdparty%2Ftornado.git

Update docstring
---

diff --git a/tornado/ioloop.py b/tornado/ioloop.py
index fff29cefb..2b0ac019f 100644
--- a/tornado/ioloop.py
+++ b/tornado/ioloop.py
@@ -839,9 +839,11 @@ class _Timeout(object):
 class PeriodicCallback(object):
     """Schedules the given callback to be called periodically.
 
-    The callback is called every ``callback_time`` milliseconds.
-    Note that the timeout is given in milliseconds, while most other
-    time-related functions in Tornado use seconds.
+    The callback is called every ``callback_time`` milliseconds when
+    ``callback_time`` is a float. Note that the timeout is given in
+    milliseconds, while most other time-related functions in Tornado use
+    seconds. ``callback_time`` may alternatively be given as a
+    `datetime.timedelta` object.
 
     If ``jitter`` is specified, each callback time will be randomly selected
     within a window of ``jitter * callback_time`` milliseconds.