diff options
author | BurdetteLamar <burdettelamar@yahoo.com> | 2020-06-25 12:09:28 -0500 |
---|---|---|
committer | BurdetteLamar <burdettelamar@yahoo.com> | 2020-06-25 12:09:28 -0500 |
commit | 7bee2c7c13ba545bda24db6259718a8b7255270a (patch) | |
tree | 3cd2ab9ea4936e292a8155f1b97231f3dd0df70c | |
parent | e7e3732130df477a43c86ac59e915a2651928249 (diff) | |
download | json-7bee2c7c13ba545bda24db6259718a8b7255270a.tar.gz |
RDoc enhancements
-rw-r--r-- | lib/json.rb | 4 | ||||
-rw-r--r-- | lib/json/common.rb | 27 |
2 files changed, 3 insertions, 28 deletions
diff --git a/lib/json.rb b/lib/json.rb index a96f4bc..8fc7e83 100644 --- a/lib/json.rb +++ b/lib/json.rb @@ -150,8 +150,8 @@ require 'json/common' # # When the source is a Ruby \Integer or \Float, JSON.generate returns # a \String containing a \JSON number: -# JSON.generate(Integer(0)) # => "0"" -# JSON.generate(Float(1.0)) # => "1.0" +# JSON.generate(42) # => "42" +# JSON.generate(0.42) # => "0.42" # # When the source is a Ruby \String, JSON.generate returns # a \String containing a \JSON string (with double-quotes): diff --git a/lib/json/common.rb b/lib/json/common.rb index 0e69050..db50b33 100644 --- a/lib/json/common.rb +++ b/lib/json/common.rb @@ -201,9 +201,6 @@ module JSON # source = '[NaN, Infinity, -Infinity]' # ruby = JSON.parse(source, {allow_nan: true}) # ruby # => [NaN, Infinity, -Infinity] - # With a truthy value: - # ruby = JSON.parse(source, {allow_nan: :foo}) - # ruby # => [NaN, Infinity, -Infinity] # # ====== Output Options # @@ -232,12 +229,6 @@ module JSON # Use class \OpenStruct: # ruby = JSON.parse(source, {object_class: OpenStruct}) # ruby # => #<OpenStruct a="foo", b=1.0, c=true, d=false, e=nil> - # Try class \Object: - # # Raises NoMethodError (undefined method `[]=' for #<Object:>): - # JSON.parse(source, {object_class: Object}) - # Bad value: - # # Raises TypeError (wrong argument type Symbol (expected Class)): - # JSON.parse(source, {object_class: :foo}) # # --- # @@ -319,7 +310,6 @@ module JSON # obj = ["foo", 1.0, true, false, nil] # json = JSON.generate(obj) # json # => "[\"foo\",1.0,true,false,null]" - # json.class # => String # # When +obj+ is a # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects], @@ -346,7 +336,7 @@ module JSON # JSON.generate(JSON::MinusInfinity) # # Allow: - # ruby = [JSON::NaN, JSON::Infinity, JSON::MinusInfinity] + # ruby = [Float::NaN, Float::Infinity, Float::MinusInfinity] # JSON.generate(ruby, allow_nan: true) # => "[NaN,Infinity,-Infinity]" # # --- @@ -362,10 +352,6 @@ module JSON # # Raises JSON::NestingError (nesting of 2 is too deep): # JSON.generate(obj, max_nesting: 2) # - # Bad Value: - # # Raises TypeError (can't convert Symbol into Hash): - # JSON.generate(obj, :foo) - # # ====== Output Options # # The default formatting options generate the most compact @@ -427,22 +413,11 @@ module JSON # # ====== Exceptions # - # Raises an exception if +obj+ is not a valid Ruby object: - # # Raises NameError (uninitialized constant Foo): - # JSON.generate(Foo) - # # Raises NameError (undefined local variable or method `foo' for main:Object): - # JSON.generate(foo) - # # Raises an exception if +obj+ contains circular references: # a = []; b = []; a.push(b); b.push(a) # # Raises JSON::NestingError (nesting of 100 is too deep): # JSON.generate(a) # - # Raises an exception if +opts is not a - # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects] - # (implementing +to_hash+): - # # Raises TypeError (can't convert Symbol into Hash): - # JSON.generate('x', :foo) def generate(obj, opts = nil) if State === opts state, opts = opts, nil |