summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurdetteLamar <burdettelamar@yahoo.com>2020-06-28 13:55:17 -0500
committerBurdetteLamar <burdettelamar@yahoo.com>2020-06-28 13:55:17 -0500
commitee5b6a74e9097c31542b10d9a32e3d3bdfc4822b (patch)
tree6dec3e7d54076c6986201b4f0a668f9ba0e00dd6
parent3d1c6a9246251e382c80dd8d85844c0bbf182da1 (diff)
downloadjson-ee5b6a74e9097c31542b10d9a32e3d3bdfc4822b.tar.gz
Added :call-seq: to RDOc for some methods
-rw-r--r--lib/json/common.rb12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/json/common.rb b/lib/json/common.rb
index c17c0ec..991d760 100644
--- a/lib/json/common.rb
+++ b/lib/json/common.rb
@@ -141,6 +141,9 @@ module JSON
module_function
+ # :call-seq:
+ # JSON.parse(source, opts) -> object
+ #
# 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.
@@ -260,6 +263,9 @@ module JSON
Parser.new(source, **(opts||{})).parse
end
+ # :call-seq:
+ # JSON.parse!(source, opts) -> object
+ #
# Calls
# parse(source, opts)
# with +source+ and possibly modified +opts+.
@@ -276,6 +282,9 @@ module JSON
Parser.new(source, **(opts||{})).parse
end
+ # :call-seq:
+ # JSON.generate(obj, opts = nil) -> new_string
+ #
# Argument +obj+ is the Ruby object to be converted to \JSON.
#
# Argument +opts+, if given, contains options for the generation, and must be a
@@ -463,6 +472,9 @@ module JSON
module_function :fast_unparse
# :startdoc:
+ # :call-seq:
+ # JSON.pretty_generate(obj, opts = nil) -> new_string
+ #
# Arguments +obj+ and +opts+ here are the same as
# arguments +obj+ and +opts+ in JSON.generate.
#