Fixes issue rq#934 - Documented Queue.delete (rq#951)

* Fixes issue rq#934 - Documented Queue.delete Fixes issue rq#934 - Code review fix * Minor doc update
RayWillett · Apr 25, 2018 · bc8d4a0 · bc8d4a0
1 parent 8b57842
commit bc8d4a0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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