Updated ttl argument docs

5 years ago · ed15b9e031
parent b62b9b0727
commit ed15b9e031
1 changed files with 2 additions and 2 deletions
--- 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.