Skip to content

Commit

Permalink
Almost ready for 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Koed00 committed Jul 4, 2015
1 parent 3899642 commit 05fa062
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
32 changes: 31 additions & 1 deletion docs/admin.rst
Expand Up @@ -3,4 +3,34 @@
Admin pages
===========

TODO
Django Q does not use custom HTML pages, but instead uses what is offered by Django's model admin by default.
When you open Django Q's admin pages you will see three models:

Successful tasks
----------------

Shows all successfully executed tasks. Meaning they did not encounter any errors during execution.
From here you can look at details of each task or delete them.

Uses the :class:`Success` proxy model.

.. tip::

The maximum number of succesful tasks can be set using the `save_limit` :ref:`configuration` option.



Failed tasks
------------
Failed tasks have encountered an error, preventing them from finishing execution.
The worker will try to put the error in the `result` field of the task so you can review what happened.

You can resubmit a failed task back to the queue using the admins action menu.

Uses the :class:`Failure` proxy model

Scheduled tasks
---------------


Uses the :class:`Schedule` model
2 changes: 1 addition & 1 deletion docs/tasks.rst
@@ -1,7 +1,7 @@
Tasks
=====

Use :py:func:`async` from your code to quickly offload tasks to the py:module:`cluster`:
Use :py:func:`async` from your code to quickly offload tasks to the :mod:`cluster`:

.. code:: python
Expand Down

0 comments on commit 05fa062

Please sign in to comment.