mirror of
https://github.com/django-q2/django-q2.git
synced 2026-09-15 13:37:56 +08:00
docs: describes the new group options
This commit is contained in:
@@ -51,7 +51,7 @@ Reference
|
||||
.. py:function:: schedule(func, *args, hook=None, schedule_type='O', repeats=-1, next_run=now() , **kwargs)
|
||||
|
||||
Creates a schedule
|
||||
|
||||
:param str name: A sensible name for your schedule
|
||||
:param str func: the function to schedule. Dotted strings only.
|
||||
:param args: arguments for the scheduled function.
|
||||
:param str hook: optional result hook function. Dotted strings only.
|
||||
@@ -68,6 +68,10 @@ Reference
|
||||
|
||||
Primary key
|
||||
|
||||
.. py:attribute:: name
|
||||
|
||||
A name for your schedule. Tasks created by this schedule will assume this as their group id.
|
||||
|
||||
.. py:attribute:: func
|
||||
|
||||
The function to be scheduled
|
||||
|
||||
Reference in New Issue
Block a user