Skip to content

Commit

Permalink
Document missing supported types [ci skip]
Browse files Browse the repository at this point in the history
This commit adds missing types to the supported types list, which
was extended in #30941
  • Loading branch information
albertoalmagro committed Nov 11, 2018
1 parent ef4f5ef commit 7c9e69d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
9 changes: 6 additions & 3 deletions activejob/lib/active_job/arguments.rb
Expand Up @@ -14,11 +14,14 @@ def initialize #:nodoc:
end

# Raised when an unsupported argument type is set as a job argument. We
# currently support NilClass, Integer, Float, String, TrueClass, FalseClass,
# BigDecimal, and objects that can be represented as GlobalIDs (ex: Active Record).
# currently support String, Integer, Float, NilClass, TrueClass, FalseClass,
# BigDecimal, Symbol, Date, Time, DateTime, ActiveSupport::TimeWithZone,
# ActiveSupport::Duration, Hash, ActiveSupport::HashWithIndifferentAccess,
# Array or GlobalID::Identification instances, although this can be extended
# by adding custom serializers.
# Raised if you set the key for a Hash something else than a string or
# a symbol. Also raised when trying to serialize an object which can't be
# identified with a Global ID - such as an unpersisted Active Record model.
# identified with a GlobalID - such as an unpersisted Active Record model.
class SerializationError < ArgumentError; end

module Arguments
Expand Down
10 changes: 6 additions & 4 deletions activejob/lib/active_job/enqueuing.rb
Expand Up @@ -9,10 +9,12 @@ module Enqueuing

# Includes the +perform_later+ method for job initialization.
module ClassMethods
# Push a job onto the queue. The arguments must be legal JSON types
# (+string+, +int+, +float+, +nil+, +true+, +false+, +hash+ or +array+) or
# GlobalID::Identification instances. Arbitrary Ruby objects
# are not supported.
# Push a job onto the queue. By default the arguments must be either String,
# Integer, Float, NilClass, TrueClass, FalseClass, BigDecimal, Symbol, Date,
# Time, DateTime, ActiveSupport::TimeWithZone, ActiveSupport::Duration,
# Hash, ActiveSupport::HashWithIndifferentAccess, Array or
# GlobalID::Identification instances, although this can be extended by adding
# custom serializers.
#
# Returns an instance of the job class queued with arguments available in
# Job#arguments.
Expand Down

0 comments on commit 7c9e69d

Please sign in to comment.