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

Updated docs for new version

Browse Source
This commit is contained in:
Ilan Steemers
2015-07-08 15:09:19 +02:00
parent d9d0e7db73
commit b2098d3f0a
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/tasks.rst
View File

@@ -93,7 +93,12 @@ Reference
.. py:attribute:: name
The name of the task
The name of the task as a humanized version of the :attr:`id`
.. note::
This is for convenience and can be used as a parameter for most functions that take a `task_id`.
Keep in mind however that it is not guaranteed to be unique if you store very large amounts of tasks in the database.
.. py:attribute:: func
@@ -119,7 +124,7 @@ Reference
.. py:attribute:: started
The moment the task was picked up by a worker
The moment the task was created by an async command
.. py:attribute:: stopped
@@ -131,11 +136,15 @@ Reference
.. py:method:: time_taken
Calculates the difference in seconds between started and stopped
Calculates the difference in seconds between started and stopped.
.. py:classmethod:: get_result(task_name)
.. note::
Get a result directly by task name
Time taken represents the time a task spends in the cluster, this includes any time it may have waited in the queue.
.. py:classmethod:: get_result(task_id)
Get a result directly by task uuid or name
.. py:class:: Success