fork/django-q2
1
0
Fork 0
mirror of https://github.com/django-q2/django-q2.git synced 2026-10-08 15:38:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: added sync configuration reference

Browse Source
This commit is contained in:
Ilan
2015-08-13 18:13:45 +02:00
parent 6c37b09151
commit 265ae9abd9
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/install.rst
+4 -2
View File
@@ -92,7 +92,7 @@ Limits the amount of successful tasks saved to Django.
- Defaults to ``250`` - Defaults to ``250``
- Failures are always saved. - Failures are always saved.
.. _queue_limit: .. _sync:
sync sync
~~~~ ~~~~
@@ -100,6 +100,8 @@ sync
When set to ``True`` this configuration option forces all :func:`async` calls to be run with ``sync=True``. When set to ``True`` this configuration option forces all :func:`async` calls to be run with ``sync=True``.
Effectively making everything synchronous. Useful for testing. Defaults to ``False``. Effectively making everything synchronous. Useful for testing. Defaults to ``False``.
.. _queue_limit:
queue_limit queue_limit
~~~~~~~~~~~ ~~~~~~~~~~~
@@ -109,7 +111,7 @@ It can also be used to manage the loss of data in case of a cluster failure.
Defaults to ``None``, meaning no limit. Defaults to ``None``, meaning no limit.
label label
~~~~~ ~~~~~Dev
The label used for the Django Admin page. Defaults to ``'Django Q'`` The label used for the Django Admin page. Defaults to ``'Django Q'``
docs/tasks.rst
+1
View File
@@ -54,6 +54,7 @@ Overrides the cluster's timeout setting for this task.
sync sync
"""" """"
Simulates a task execution synchronously. Useful for testing. Simulates a task execution synchronously. Useful for testing.
Can also be forced globally via the :ref:`sync` configuration option.
redis redis
""""" """""