util
/
rq
mirror of https://github.com/peter4431/rq.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarifying "timeout" argument in docs

Browse Source
main
Selwin Ong 7 years ago committed by GitHub
parent 3133d94b58
commit 0a47717fd2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File

4
docs/docs/index.md
Unescape Escape View File

@ -61,8 +61,8 @@ In addition, you can add a few options to modify the behaviour of the queued
job. By default, these are popped out of the kwargs that will be passed to the job. By default, these are popped out of the kwargs that will be passed to the
job function. job function.
* `timeout` specifies the maximum runtime of the job before it'll be considered * `timeout` specifies the maximum runtime of the job before it's interrupted
'lost'. 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'`). 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 the expiry time of the key where the job result will * `result_ttl` specifies the expiry time of the key where the job result will
be stored be stored
* `ttl` specifies the maximum queued time of the job before it'll be cancelled * `ttl` specifies the maximum queued time of the job before it'll be cancelled

Write Preview
Loading…
Cancel
Save