diff options
author | Selwin Ong <selwin.ong@gmail.com> | 2020-02-25 08:13:50 +0700 |
---|---|---|
committer | Selwin Ong <selwin.ong@gmail.com> | 2020-02-25 08:13:50 +0700 |
commit | 57f8fe6a0cdee6f9029dfc55dc31a8bf2af6b5ba (patch) | |
tree | 8233a26e46d51182cdd04a0187a195d46106d6d7 | |
parent | a49680f789a48fe7e464ece111bbc561cd42da3c (diff) | |
download | rq-57f8fe6a0cdee6f9029dfc55dc31a8bf2af6b5ba.tar.gz |
Updated job.result docs.
-rw-r--r-- | docs/docs/jobs.md | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/docs/docs/jobs.md b/docs/docs/jobs.md index a38466f..16c9860 100644 --- a/docs/docs/jobs.md +++ b/docs/docs/jobs.md @@ -101,15 +101,11 @@ Some interesting job attributes include: * `job.func_name` * `job.args` arguments passed to the underlying job function * `job.kwargs` key word arguments passed to the underlying job function -* `job.result` The return value of the function. Initially, right after enqueueing -a job, the return value will be None. But when the job has been executed, and had -a return value or exception, this will return that value or exception. -Return values written back to Redis will expire according to the `result_ttl` parameter -of the job (500 seconds by default). +* `job.result` stores the return value of the job being executed, will return `None` prior to job execution. Results are kept according to the `result_ttl` parameter (500 seconds by default). * `job.enqueued_at` * `job.started_at` * `job.ended_at` -* `job.exc_info` +* `job.exc_info` stores exception information if job doesn't finish successfully. If you want to efficiently fetch a large number of jobs, use `Job.fetch_many()`. |