Skip to content

Commit

Permalink
Docs: Add details about reusing a unique job id (#391)
Browse files Browse the repository at this point in the history 
See: 
* #138 (comment)
* #221
  • Loading branch information
@ross-nordstrom
ross-nordstrom authored Mar 19, 2023
1 parent bfa8e68 commit e0cd916
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Sometimes you want a job to only be run once at a time (eg. a backup) or once fo
invoices for a particular company).

*arq* supports this via custom job ids, see :func:`arq.connections.ArqRedis.enqueue_job`. It guarantees
that a job with a particular ID cannot be enqueued again until its execution has finished.
that a job with a particular ID cannot be enqueued again until its execution has finished and its result has cleared. To control when a finished job's result clears, you can use the `keep_result` setting on your worker, see :func:`arq.worker.func`.

.. literalinclude:: examples/job_ids.py

Expand Down

1 comment on commit e0cd916

@epicwhale
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful to publish this doc release! As the current doc without the information on 'its result has cleared' makes it confusing to use unique job ids. (for example: #432)

Please sign in to comment.