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] Added :call-seq: to RDOc for some methods

Browse source 
ee5b6a74e9
This commit is contained in:
BurdetteLamar 2020-06-28 13:55:17 -05:00 • committed by Hiroshi SHIBATA
parent cb3e62511c
commit d69b55ac05
No known key found for this signature in database
GPG key ID: F9CF13417264FAC2
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -141,6 +141,9 @@ module JSON
module_function module_function
# :call-seq:
# JSON.parse(source, opts) -> object
#
# Argument +source+ contains the \String to be parsed. It must be a # Argument +source+ contains the \String to be parsed. It must be a
# {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects] # {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects]
# (implementing +to_str+), and must contain valid \JSON data. # (implementing +to_str+), and must contain valid \JSON data.
@ -260,6 +263,9 @@ module JSON
Parser.new(source, **(opts||{})).parse Parser.new(source, **(opts||{})).parse
end end
# :call-seq:
# JSON.parse!(source, opts) -> object
#
# Calls # Calls
# parse(source, opts) # parse(source, opts)
# with +source+ and possibly modified +opts+. # with +source+ and possibly modified +opts+.
@ -276,6 +282,9 @@ module JSON
Parser.new(source, **(opts||{})).parse Parser.new(source, **(opts||{})).parse
end end
# :call-seq:
# JSON.generate(obj, opts = nil) -> new_string
#
# 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 options for the generation, and must be a
@ -463,6 +472,9 @@ module JSON
module_function :fast_unparse module_function :fast_unparse
# :startdoc: # :startdoc:
# :call-seq:
# JSON.pretty_generate(obj, opts = nil) -> new_string
#
# Arguments +obj+ and +opts+ here are the same as # Arguments +obj+ and +opts+ here are the same as
# arguments +obj+ and +opts+ in JSON.generate. # arguments +obj+ and +opts+ in JSON.generate.
# #