RDoc enqueue

seuros · May 19, 2014 · fc80f4e · fc80f4e
1 parent 08d8600
commit fc80f4e
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/lib/active_job/enqueuing.rb b/lib/active_job/enqueuing.rb
@@ -2,8 +2,16 @@
 
 module ActiveJob
   module Enqueuing
+    ##
+    # Push a job onto the queue.  The arguments must be legal JSON types
+    # (string, int, float, nil, true, false, hash or array) or
+    # ActiveModel::GlobalIdentication instances.  Arbitrary Ruby objects
+    # are not supported.
+    #
+    # The return value is adapter-specific and may change in a future
+    # ActiveJob release.
     def enqueue(*args)
       queue_adapter.queue self, *Parameters.serialize(args)
     end
   end
-end
+end