Skip to content

Commit 3a73a96

Browse files
authored
Merge pull request #851 from tcely/patch-1
Add `periodic_task` to mini.rst
2 parents 891104d + 7af8ff3 commit 3a73a96

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/mini.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ Usage and task declaration:
6565
def run_backup():
6666
pass
6767
68+
@huey.periodic_task(crontab(hour='10,14', minute='30'))
69+
def send_reminders():
70+
pass
71+
72+
6873
Example usage. Running tasks and getting results work about the same as
6974
regular Huey:
7075

@@ -114,11 +119,6 @@ Usage and task declaration:
114119
115120
Stop the scheduler.
116121

117-
.. note::
118-
There is not a separate decorator for *periodic*, or *crontab*, tasks. Just
119-
use :py:meth:`MiniHuey.task` and pass in a validation function. A
120-
validation function can be generated using the :py:func:`crontab` function.
121-
122122
.. note::
123123
Tasks enqueued for immediate execution will be run regardless of whether
124124
the scheduler is running. You only need to start the scheduler if you plan

0 commit comments

Comments
 (0)