1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Fix call-seq for ObjectSpace methods

Browse Source
This commit is contained in:
Peter Zhu 2022-12-12 09:58:39 -05:00
parent 58e3ce5de6
commit a9c3dc8d2e
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
ext/objspace/lib/objspace.rb
View File

@ -12,9 +12,9 @@ module ObjectSpace
module_function module_function
# call-seq: # call-seq:
# ObjectSpace.dump(obj[, output: :string]) # => "{ ... }" # ObjectSpace.dump(obj[, output: :string]) -> "{ ... }"
# ObjectSpace.dump(obj, output: :file) # => #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json> # ObjectSpace.dump(obj, output: :file) -> #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
# ObjectSpace.dump(obj, output: :stdout) # => nil # ObjectSpace.dump(obj, output: :stdout) -> nil
# #
# Dump the contents of a ruby object as JSON. # Dump the contents of a ruby object as JSON.
# #
@ -44,13 +44,11 @@ module ObjectSpace
# call-seq: # call-seq:
# ObjectSpace.dump_all([output: :file]) # => #<File:/tmp/rubyheap20131125-88469-laoj3v.json> # ObjectSpace.dump_all([output: :file]) -> #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
# ObjectSpace.dump_all(output: :stdout) # => nil # ObjectSpace.dump_all(output: :stdout) -> nil
# ObjectSpace.dump_all(output: :string) # => "{...}\n{...}\n..." # ObjectSpace.dump_all(output: :string) -> "{...}\n{...}\n..."
# ObjectSpace.dump_all(output: # ObjectSpace.dump_all(output: File.open('heap.json','w')) -> #<File:heap.json>
# File.open('heap.json','w')) # => #<File:heap.json> # ObjectSpace.dump_all(output: :string, since: 42) -> "{...}\n{...}\n..."
# ObjectSpace.dump_all(output: :string,
# since: 42) # => "{...}\n{...}\n..."
# #
# Dump the contents of the ruby heap as JSON. # Dump the contents of the ruby heap as JSON.
# #
@ -107,13 +105,11 @@ module ObjectSpace
end end
# call-seq: # call-seq:
# ObjectSpace.dump_shapes([output: :file]) # => #<File:/tmp/rubyshapes20131125-88469-laoj3v.json> # ObjectSpace.dump_shapes([output: :file]) -> #<File:/tmp/rubyshapes20131125-88469-laoj3v.json>
# ObjectSpace.dump_shapes(output: :stdout) # => nil # ObjectSpace.dump_shapes(output: :stdout) -> nil
# ObjectSpace.dump_shapes(output: :string) # => "{...}\n{...}\n..." # ObjectSpace.dump_shapes(output: :string) -> "{...}\n{...}\n..."
# ObjectSpace.dump_shapes(output: # ObjectSpace.dump_shapes(output: File.open('shapes.json','w')) -> #<File:shapes.json>
# File.open('shapes.json','w')) # => #<File:shapes.json> # ObjectSpace.dump_all(output: :string, since: 42) -> "{...}\n{...}\n..."
# ObjectSpace.dump_all(output: :string,
# since: 42) # => "{...}\n{...}\n..."
# #
# Dump the contents of the ruby shape tree as JSON. # Dump the contents of the ruby shape tree as JSON.
# #