summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSelwin Ong <selwin.ong@gmail.com>2019-09-08 18:19:38 +0700
committerSelwin Ong <selwin.ong@gmail.com>2019-09-08 18:19:38 +0700
commited15b9e031eab74f2216f333883321be78bd4056 (patch)
treeb563a2673e967a6936a4ec4ac904d76070ea5042
parentb62b9b0727eb7f6526a6842df1dee7b463729e1d (diff)
downloadrq-ed15b9e031eab74f2216f333883321be78bd4056.tar.gz
Updated ttl argument docs
-rw-r--r--docs/docs/index.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/docs/index.md b/docs/docs/index.md
index a4f9a8f..979e7d2 100644
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -66,8 +66,8 @@ job function.
and marked as `failed`. Its default unit is second and it can be an integer or a string representing an integer(e.g. `2`, `'2'`). Furthermore, it can be a string with specify unit including hour, minute, second(e.g. `'1h'`, `'3m'`, `'5s'`).
* `result_ttl` specifies how long (in seconds) successful jobs and their
results are kept. Expired jobs will be automatically deleted. Defaults to 500 seconds.
-* `ttl` specifies the maximum queued time of the job before it's discarded.
- If you specify a value of `-1` you indicate an infinite job ttl and it will run indefinitely
+* `ttl` specifies the maximum queued time (in seconds) of the job before it's discarded.
+ This argument defaults to `None` (infinite TTL).
* `failure_ttl` specifies how long failed jobs are kept (defaults to 1 year)
* `depends_on` specifies another job (or job id) that must complete before this
job will be queued.