fork/django-q2
1
0
Fork 0
mirror of https://github.com/django-q2/django-q2.git synced 2026-09-29 16:18:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs updates (#6)

Browse Source 
* Update django docs links to 4.0
* Update Django Q to Django Q2
* Use different theme to make difference more clear between the original and this forked one
* Added info notice about this fork
* Some small layout/typo fixes
This commit is contained in:
Stan Triepels
2022-10-13 01:38:24 +02:00
committed by GitHub
parent f698792f60
commit d32d3f5a09
18 changed files with 115 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tasks.rst
+3 -6
View File
@@ -7,9 +7,6 @@ Tasks
async_task()
------------
.. warning:: Since Python 3.7 `async` became a reserved keyword and was refactored to `async_task`
Use :func:`async_task` from your code to quickly offload tasks to the :class:`Cluster`:
.. code:: python
@@ -101,7 +98,7 @@ Please note that this will override any other option keywords.
.. note::
For tasks to be processed you will need to have a worker cluster running in the background using ``python manage.py qcluster``
or you need to configure Django Q to run in synchronous mode for testing using the :ref:`sync` option.
or you need to configure Django Q2 to run in synchronous mode for testing using the :ref:`sync` option.
AsyncTask
@@ -221,7 +218,7 @@ Instead of setting ``sync`` on each individual ``async_task`` you can also confi
Connection pooling
------------------
Django Q tries to pass broker instances around its parts as much as possible to save you from running out of connections.
Django Q2 tries to pass broker instances around its parts as much as possible to save you from running out of connections.
When you are making individual calls to :func:`async_task` a lot though, it can help to set up a broker to reuse for :func:`async_task`:
.. code:: python
@@ -236,7 +233,7 @@ When you are making individual calls to :func:`async_task` a lot though, it can
.. tip::
If you are using `django-redis <https://github.com/niwinz/django-redis>`__ and the redis broker, you can :ref:`configure <django_redis>` Django Q to use its connection pool.
If you are using `django-redis <https://github.com/niwinz/django-redis>`__ and the redis broker, you can :ref:`configure <django_redis>` Django Q2 to use its connection pool.
Reference