Improve docstring

This commit is contained in:
Griatch 2018-08-20 20:39:04 +02:00
parent 1923689040
commit 6ec7c7a63f

View file

@ -1011,16 +1011,16 @@ def delay(timedelay, callback, *args, **kwargs):
Args: Args:
timedelay (int or float): The delay in seconds timedelay (int or float): The delay in seconds
callback (callable): Will be called with optional callback (callable): Will be called as `callback(*args, **kwargs)`
arguments after `timedelay` seconds. after `timedelay` seconds.
args (any, optional): Will be used as arguments to callback args (any, optional): Will be used as arguments to callback
Kwargs: Kwargs:
persistent (bool, optional): should make the delay persistent persistent (bool, optional): should make the delay persistent
over a reboot or reload over a reboot or reload
any (any): Will be used to call the callback. any (any): Will be used as keyword arguments to callback.
Returns: Returns:
deferred (deferred): Will fire fire with callback after deferred (deferred): Will fire with callback after
`timedelay` seconds. Note that if `timedelay()` is used in the `timedelay` seconds. Note that if `timedelay()` is used in the
commandhandler callback chain, the callback chain can be commandhandler callback chain, the callback chain can be
defined directly in the command body and don't need to be defined directly in the command body and don't need to be