From dfeec653c5989e61d71bdd9c0511bfc5e244b18f Mon Sep 17 00:00:00 2001 From: "Michael V. DePalatis" Date: Wed, 5 May 2021 09:55:24 -0600 Subject: [PATCH] Update docstring --- tornado/ioloop.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) 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. -- 2.47.2