Skip to content

Fixed documentation for queue.update_claim #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2013
Merged

Fixed documentation for queue.update_claim #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/queues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ If there are no messages to claim, the method returns `None`. When you create a
## Renewing a Claim
Once a claim has been made, if the TTL and grace period expire, the claim is automatically released and the messages are made available for others to claim. If you have a long-running process and want to ensure that this does not happen in the middle of the process, you should update the claim with one or both of a TTL or grace period. Updating resets the age of the claim, restarting the TTL for the claim. To update a claim, call:

pq.update_claim(queue, claim[, ttl=None][, grace_period=None])
pq.update_claim(queue, claim[, ttl=None][, grace=None])
# or
queue.update_claim(claim[, ttl=None][, grace_period=None])
queue.update_claim(claim[, ttl=None][, grace=None])


## Refreshing a Claim
Expand Down