docs: adds 'save' option to function references

This commit is contained in:
Ilan
2015-07-21 14:23:57 +02:00
parent 4ceff55b43
commit 0d1f106470
3 changed files with 4 additions and 3 deletions

View File

@@ -136,7 +136,7 @@ Meanwhile the the sentinel checks if the timers don't exceed the timeout amount,
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
- Subtracts 1 from :attr:`django_q.Schedule.repeats`

View File

@@ -55,7 +55,7 @@ If you want to schedule regular Django management commands, you can use the :mod
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

View File

@@ -177,7 +177,7 @@ Reference
---------
.. 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
@@ -186,6 +186,7 @@ Reference
:param object hook: Optional function to call after execution
:param str group: An optional group identifier
: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 redis: Optional redis connection
:param dict q_options: Options dict, overrides option keywords