mirror of
https://github.com/django-q2/django-q2.git
synced 2026-10-08 04:18:13 +08:00
docs: adds 'save' option to function references
This commit is contained in:
+1
-1
@@ -136,7 +136,7 @@ Meanwhile the the sentinel checks if the timers don't exceed the timeout amount,
|
|||||||
|
|
||||||
Scheduler
|
Scheduler
|
||||||
"""""""""
|
"""""""""
|
||||||
Once a minute the scheduler checks for any scheduled task that should be starting.
|
Once a minute the scheduler checks for any scheduled tasks that should be starting.
|
||||||
|
|
||||||
- Creates a task from the schedule
|
- Creates a task from the schedule
|
||||||
- Subtracts 1 from :attr:`django_q.Schedule.repeats`
|
- Subtracts 1 from :attr:`django_q.Schedule.repeats`
|
||||||
|
|||||||
+1
-1
@@ -55,7 +55,7 @@ If you want to schedule regular Django management commands, you can use the :mod
|
|||||||
Reference
|
Reference
|
||||||
---------
|
---------
|
||||||
|
|
||||||
.. py:function:: schedule(func, *args, name=None, hook=None, schedule_type='O', repeats=-1, next_run=now() , **kwargs)
|
.. py:function:: schedule(func, *args, name=None, hook=None, schedule_type='O', repeats=-1, next_run=now() , q_options=None, **kwargs)
|
||||||
|
|
||||||
Creates a schedule
|
Creates a schedule
|
||||||
|
|
||||||
|
|||||||
+2
-1
@@ -177,7 +177,7 @@ Reference
|
|||||||
---------
|
---------
|
||||||
|
|
||||||
.. py:function:: async(func, *args, hook=None, group=None, timeout=None,\
|
.. py:function:: async(func, *args, hook=None, group=None, timeout=None,\
|
||||||
sync=False, redis=None, q_options=None, **kwargs)
|
save=None, sync=False, redis=None, q_options=None, **kwargs)
|
||||||
|
|
||||||
Puts a task in the cluster queue
|
Puts a task in the cluster queue
|
||||||
|
|
||||||
@@ -186,6 +186,7 @@ Reference
|
|||||||
:param object hook: Optional function to call after execution
|
:param object hook: Optional function to call after execution
|
||||||
:param str group: An optional group identifier
|
:param str group: An optional group identifier
|
||||||
:param int timeout: Overrides global cluster :ref:`timeout`.
|
:param int timeout: Overrides global cluster :ref:`timeout`.
|
||||||
|
:param bool save: Overrides global save setting for this task.
|
||||||
:param bool sync: If set to True, async will simulate a task execution
|
:param bool sync: If set to True, async will simulate a task execution
|
||||||
:param redis: Optional redis connection
|
:param redis: Optional redis connection
|
||||||
:param dict q_options: Options dict, overrides option keywords
|
:param dict q_options: Options dict, overrides option keywords
|
||||||
|
|||||||
Reference in New Issue
Block a user