Add docs to Resque.enque regarding return value

hone · Sep 22, 2011 · ca2e8ac · ca2e8ac
1 parent 5fee4cd
commit ca2e8ac
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/resque.rb b/lib/resque.rb
@@ -222,6 +222,9 @@ def watch_queue(queue)
   #
   # If no queue can be inferred this method will raise a `Resque::NoQueueError`
   #
+  # Returns true if the job was queued, nil if the job was rejected by a 
+  # before_enqueue hook.
+  #
   # This method is considered part of the `stable` API.
   def enqueue(klass, *args)
     # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false