[ci skip] Update documentation for GC.stat

This commit is contained in:
Peter Zhu 2021-11-29 09:33:54 -05:00
parent 659c864a43
commit f8ead3a72f
Notes: git 2021-11-29 23:40:52 +09:00

8
gc.rb
View File

@ -123,13 +123,13 @@ module GC
# call-seq: # call-seq:
# GC.stat -> Hash # GC.stat -> Hash
# GC.stat(hash) -> hash # GC.stat(hash) -> Hash
# GC.stat(:key) -> Numeric # GC.stat(:key) -> Numeric
# #
# Returns a Hash containing information about the GC. # Returns a Hash containing information about the GC.
# #
# The contents of the hash are implementation specific and may be changed in # The contents of the hash are implementation specific and may change in
# the future. # the future without notice.
# #
# The hash includes information about internal statistics about GC such as: # The hash includes information about internal statistics about GC such as:
# #
@ -191,7 +191,7 @@ module GC
# it is overwritten and returned. # it is overwritten and returned.
# This is intended to avoid probe effect. # This is intended to avoid probe effect.
# #
# This method is only expected to work on C Ruby. # This method is only expected to work on CRuby.
def self.stat hash_or_key = nil def self.stat hash_or_key = nil
Primitive.gc_stat hash_or_key Primitive.gc_stat hash_or_key
end end