Skip to content

Commit

Permalink
Update docs to add cluster option to the async_task (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
GDay committed Feb 18, 2024
1 parent 1b638e5 commit 6265a54
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/tasks.rst
Expand Up @@ -75,6 +75,10 @@ broker
""""""
A broker instance, in case you want to control your own connections.

cluster
""""""
The name of the cluster. Only useful if you are using [alternative queues](https://django-q2.readthedocs.io/en/master/cluster.html#multiple-queues).

task_name
"""""""""

Expand Down Expand Up @@ -241,7 +245,7 @@ Reference
---------

.. py:function:: async_task(func, *args, hook=None, group=None, timeout=None,\
save=None, sync=False, cached=False, broker=None, q_options=None, **kwargs)
save=None, sync=False, cached=False, broker=None, cluster=None, q_options=None, **kwargs)
Puts a task in the cluster queue

Expand All @@ -255,6 +259,7 @@ Reference
:param bool sync: If set to True, async_task will simulate a task execution
:param cached: Output the result to the cache backend. Bool or timeout in seconds
:param broker: Optional broker connection from :func:`brokers.get_broker`
:param cluster: Optional cluster name if using alternative queues
:param dict q_options: Options dict, overrides option keywords
:param dict kwargs: Keyword arguments for the task function
:returns: The uuid of the task
Expand Down

0 comments on commit 6265a54

Please sign in to comment.