diff options
Diffstat (limited to 'taskflow/types/periodic.py')
| -rw-r--r-- | taskflow/types/periodic.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/taskflow/types/periodic.py b/taskflow/types/periodic.py index f00d97e..9237d9c 100644 --- a/taskflow/types/periodic.py +++ b/taskflow/types/periodic.py @@ -39,7 +39,12 @@ _PERIODIC_ATTRS = tuple([ def periodic(spacing, run_immediately=True): - """Tags a method/function as wanting/able to execute periodically.""" + """Tags a method/function as wanting/able to execute periodically. + + :param run_immediately: option to specify whether to run + immediately or not + :type run_immediately: boolean + """ if spacing <= 0: raise ValueError("Periodicity/spacing must be greater than" |