archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-09-24 04:54:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[flori/json] Partial compliance with doc/method_documentation.rdoc

Browse source 
6dfa885134
This commit is contained in:
BurdetteLamar 2020-08-20 11:37:42 -05:00 • committed by Hiroshi SHIBATA
parent 71f64e15b9
commit 038252fe66
Notes: git 2020-09-25 17:29:10 +09:00
1 changed files with 7 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

24
ext/json/lib/json/common.rb
View file

@ -7,8 +7,7 @@ module JSON
# :call-seq: # :call-seq:
# JSON[object] -> new_array or new_string # JSON[object] -> new_array or new_string
# #
# If +object+ is a # If +object+ is a \String,
# {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects],
# calls JSON.parse with +object+ and +opts+ (see method #parse): # calls JSON.parse with +object+ and +opts+ (see method #parse):
# json = '[0, 1, null]' # json = '[0, 1, null]'
# JSON[json]# => [0, 1, nil] # JSON[json]# => [0, 1, nil]
@ -149,12 +148,9 @@ module JSON
# #
# Returns the Ruby objects created by parsing the given +source+. # Returns the Ruby objects created by parsing the given +source+.
# #
# Argument +source+ contains the \String to be parsed. It must be a # Argument +source+ contains the \String to be parsed.
# {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects]
# (implementing +to_str+), and must contain valid \JSON data.
# #
# Argument +opts+, if given, contains options for the parsing, and must be a # Argument +opts+, if given, contains a \Hash of options for the parsing.
# {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash+Convertible+Objects].
# See {Parsing Options}[#module-JSON-label-Parsing+Options]. # See {Parsing Options}[#module-JSON-label-Parsing+Options].
# #
# --- # ---
@ -249,22 +245,17 @@ module JSON
# #
# Argument +obj+ is the Ruby object to be converted to \JSON. # Argument +obj+ is the Ruby object to be converted to \JSON.
# #
# Argument +opts+, if given, contains options for the generation, and must be a # Argument +opts+, if given, contains a \Hash of options for the generation.
# {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects].
# See {Generating Options}[#module-JSON-label-Generating+Options]. # See {Generating Options}[#module-JSON-label-Generating+Options].
# #
# --- # ---
# #
# When +obj+ is an # When +obj+ is an \Array, returns a \String containing a \JSON array:
# {Array-convertible object}[doc/implicit_conversion_rdoc.html#label-Array-Convertible+Objects]
# (implementing +to_ary+), returns a \String containing a \JSON array:
# obj = ["foo", 1.0, true, false, nil] # obj = ["foo", 1.0, true, false, nil]
# json = JSON.generate(obj) # json = JSON.generate(obj)
# json # => '["foo",1.0,true,false,null]' # json # => '["foo",1.0,true,false,null]'
# #
# When +obj+ is a # When +obj+ is a \Hash, returns a \String containing a \JSON object:
# {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects],
# return a \String containing a \JSON object:
# obj = {foo: 0, bar: 's', baz: :bat} # obj = {foo: 0, bar: 's', baz: :bat}
# json = JSON.generate(obj) # json = JSON.generate(obj)
# json # => '{"foo":0,"bar":"s","baz":"bat"}' # json # => '{"foo":0,"bar":"s","baz":"bat"}'
@ -436,8 +427,7 @@ module JSON
# BEWARE: This method is meant to serialise data from trusted user input, # BEWARE: This method is meant to serialise data from trusted user input,
# like from your own database server or clients under your control, it could # like from your own database server or clients under your control, it could
# be dangerous to allow untrusted users to pass JSON sources into it. # be dangerous to allow untrusted users to pass JSON sources into it.
# - Argument +opts+, if given, contains options for the parsing, and must be a # - Argument +opts+, if given, contains a \Hash of options for the parsing.
# {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash+Convertible+Objects].
# See {Parsing Options}[#module-JSON-label-Parsing+Options]. # See {Parsing Options}[#module-JSON-label-Parsing+Options].
# The default options can be changed via method JSON.load_default_options=. # The default options can be changed via method JSON.load_default_options=.
# #