From bc8d4a087ae7be0f821ac7620bf50127773f9123 Mon Sep 17 00:00:00 2001 From: Theofanis Despoudis Date: Wed, 25 Apr 2018 08:42:20 +0100 Subject: [PATCH] Fixes issue #934 - Documented Queue.delete (#951) * Fixes issue #934 - Documented Queue.delete Fixes issue #934 - Code review fix * Minor doc update --- docs/docs/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/index.md b/docs/docs/index.md index 8f8bb0b..58216f8 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -112,8 +112,13 @@ print len(q) queued_job_ids = q.job_ids # Gets a list of job IDs from the queue queued_jobs = q.jobs # Gets a list of enqueued job instances job = q.fetch_job('my_id') # Returns job having ID "my_id" + +# Deleting the queue +q.delete(delete_jobs=True) # Passing in `True` will remove all jobs in the queue +# queue is unusable now unless re-instantiated {% endhighlight %} + ### On the Design With RQ, you don't have to set up any queues upfront, and you don't have to