Skip to content

Commit

Permalink
Docs update, refs #394
Browse files Browse the repository at this point in the history
  • Loading branch information
coleifer committed Feb 16, 2019
1 parent db68a55 commit 1c39de8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,15 @@ Function decorators and helpers
periodic task, effectively enabling you to pause it or prevent its execution.
For more information, see :py:class:`TaskWrapper`.

.. note::
The result (return value) of a periodic task is not stored in the
result store. This is primarily due to the fact that there is not
an obvious way one would read such results, since the invocation of
the periodic task happens inside the consumer scheduler. As such,
there is no task result handle which the user could use to read the
result. To store the results of periodic tasks, you will need to
use your own storage.

.. py:method:: enqueue(task)
Enqueue the given task. When the result store is enabled (on by
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,8 @@ Now, when we run the consumer it will start printing the time every minute:

.. image:: crontab.png

.. note::
Periodic task return value will not be stored in the result store.

Canceling or pausing tasks
--------------------------
Expand Down

0 comments on commit 1c39de8

Please sign in to comment.