Add docs to Resque.enque regarding return value

raykrueger · raykrueger · commit ca2e8acba699 · 2011-09-22T17:56:23.000-05:00
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

Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,9 @@ def watch_queue(queue)`
`222`	`222`	`#`
`223`	`223`	# If no queue can be inferred this method will raise a `Resque::NoQueueError`
`224`	`224`	`#`
	`225`	`+ # Returns true if the job was queued, nil if the job was rejected by a`
	`226`	`+ # before_enqueue hook.`
	`227`	`+ #`
`225`	`228`	# This method is considered part of the `stable` API.
`226`	`229`	`def enqueue(klass, *args)`
`227`	`230`	`# Perform before_enqueue hooks. Don't perform enqueue if any hook returns false`