summaryrefslogtreecommitdiff
path: root/ext/json/lib
diff options
context:
space:
mode:
authorBurdetteLamar <burdettelamar@yahoo.com>2020-08-20 11:37:42 -0500
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2020-09-25 17:28:42 +0900
commit038252fe66d4a81f21027e8204b782363a8516c8 (patch)
tree74c181fa263c959cc0c339f8e8f4fb25a9eff61b /ext/json/lib
parent71f64e15b9e23f08b8c31500efb971a61b8b2b18 (diff)
[flori/json] Partial compliance with doc/method_documentation.rdoc
https://github.com/flori/json/commit/6dfa885134
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/3581
Diffstat (limited to 'ext/json/lib')
-rw-r--r--ext/json/lib/json/common.rb24
1 files changed, 7 insertions, 17 deletions
diff --git a/ext/json/lib/json/common.rb b/ext/json/lib/json/common.rb
index 2f101e7eddf..2e4aa2a4317 100644
--- a/ext/json/lib/json/common.rb
+++ b/ext/json/lib/json/common.rb
@@ -7,8 +7,7 @@ module JSON
# :call-seq:
# JSON[object] -> new_array or new_string
#
- # If +object+ is a
- # {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects],
+ # If +object+ is a \String,
# calls JSON.parse with +object+ and +opts+ (see method #parse):
# json = '[0, 1, null]'
# JSON[json]# => [0, 1, nil]
@@ -149,12 +148,9 @@ module JSON
#
# Returns the Ruby objects created by parsing the given +source+.
#
- # Argument +source+ contains the \String to be parsed. It must be a
- # {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects]
- # (implementing +to_str+), and must contain valid \JSON data.
+ # Argument +source+ contains the \String to be parsed.
#
- # Argument +opts+, if given, contains options for the parsing, and must be a
- # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash+Convertible+Objects].
+ # Argument +opts+, if given, contains a \Hash of options for the parsing.
# 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 +opts+, if given, contains options for the generation, and must be a
- # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects].
+ # Argument +opts+, if given, contains a \Hash of options for the generation.
# See {Generating Options}[#module-JSON-label-Generating+Options].
#
# ---
#
- # When +obj+ is an
- # {Array-convertible object}[doc/implicit_conversion_rdoc.html#label-Array-Convertible+Objects]
- # (implementing +to_ary+), returns a \String containing a \JSON array:
+ # When +obj+ is an \Array, returns a \String containing a \JSON array:
# obj = ["foo", 1.0, true, false, nil]
# json = JSON.generate(obj)
# json # => '["foo",1.0,true,false,null]'
#
- # When +obj+ is a
- # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash-Convertible+Objects],
- # return a \String containing a \JSON object:
+ # When +obj+ is a \Hash, returns a \String containing a \JSON object:
# obj = {foo: 0, bar: 's', baz: :bat}
# json = JSON.generate(obj)
# 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,
# 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.
- # - Argument +opts+, if given, contains options for the parsing, and must be a
- # {Hash-convertible object}[doc/implicit_conversion_rdoc.html#label-Hash+Convertible+Objects].
+ # - Argument +opts+, if given, contains a \Hash of options for the parsing.
# See {Parsing Options}[#module-JSON-label-Parsing+Options].
# The default options can be changed via method JSON.load_default_options=.
#