rbs 3.9.4 → 3.10.2

data/core/nil_class.rbs

@@ -112,7 +112,7 @@ class NilClass
   def nil?: () -> true
 
   # <!--
-  #   rdoc-file=rational.c
+  #   rdoc-file=nilclass.rb
   #   - rationalize(eps = nil)  ->  (0/1)
   # -->
   # Returns zero as a Rational:
@@ -134,7 +134,7 @@ class NilClass
   def to_a: () -> []
 
   # <!--
-  #   rdoc-file=complex.c
+  #   rdoc-file=nilclass.rb
   #   - to_c -> (0+0i)
   # -->
   # Returns zero as a Complex:
@@ -174,7 +174,7 @@ class NilClass
   def to_i: () -> 0
 
   # <!--
-  #   rdoc-file=rational.c
+  #   rdoc-file=nilclass.rb
   #   - to_r  ->  (0/1)
   # -->
   # Returns zero as a Rational:

data/core/numeric.rbs

@@ -160,7 +160,7 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - self % other -> real_numeric
   # -->
-  # Returns `self` modulo `other` as a real number.
+  # Returns `self` modulo `other` as a real numeric (Integer, Float, or Rational).
   #
   # Of the Core and Standard Library classes, only Rational uses this
   # implementation.
@@ -212,7 +212,7 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - -self -> numeric
   # -->
-  # Unary Minus---Returns the receiver, negated.
+  # Returns `self`, negated.
   #
   def -@: () -> Numeric
 
@@ -220,7 +220,15 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - self <=> other -> zero or nil
   # -->
-  # Returns zero if `self` is the same as `other`, `nil` otherwise.
+  # Compares `self` and `other`.
+  #
+  # Returns:
+  #
+  # *   Zero, if `self` is the same as `other`.
+  # *   `nil`, otherwise.
+  #
+  # Class Numeric includes module Comparable, each of whose methods uses
+  # Numeric#<=> for comparison.
   #
   # No subclass in the Ruby Core or Standard Library uses this implementation.
   #
@@ -336,7 +344,7 @@ class Numeric
   #   - div(other) -> integer
   # -->
   # Returns the quotient `self/other` as an integer (via `floor`), using method
-  # `/` in the derived class of `self`. (Numeric itself does not define method
+  # `/` as defined in the subclass of Numeric. (Numeric itself does not define
   # `/`.)
   #
   # Of the Core and Standard Library classes, Only Float and Rational use this
@@ -398,8 +406,8 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - fdiv(other) -> float
   # -->
-  # Returns the quotient `self/other` as a float, using method `/` in the derived
-  # class of `self`. (Numeric itself does not define method `/`.)
+  # Returns the quotient `self/other` as a float, using method `/` as defined in
+  # the subclass of Numeric. (Numeric itself does not define `/`.)
   #
   # Of the Core and Standard Library classes, only BigDecimal uses this
   # implementation.
@@ -488,7 +496,7 @@ class Numeric
   alias magnitude abs
 
   # <!-- rdoc-file=numeric.c -->
-  # Returns `self` modulo `other` as a real number.
+  # Returns `self` modulo `other` as a real numeric (Integer, Float, or Rational).
   #
   # Of the Core and Standard Library classes, only Rational uses this
   # implementation.
@@ -530,17 +538,17 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - nonzero?  ->  self or nil
   # -->
-  # Returns +self+ if +self+ is not a zero value, +nil+ otherwise;
-  #     uses method <tt>zero?</tt> for the evaluation.
+  # Returns `self` if `self` is not a zero value, `nil` otherwise; uses method
+  # `zero?` for the evaluation.
   #
-  #     The returned +self+ allows the method to be chained:
+  # The returned `self` allows the method to be chained:
   #
-  #       a = %w[z Bb bB bb BB a aA Aa AA A]
-  #       a.sort {|a, b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
-  #       # => ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
+  #     a = %w[z Bb bB bb BB a aA Aa AA A]
+  #     a.sort {|a, b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
+  #     # => ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
   #
-  #     Of the Core and Standard Library classes,
-  #     Integer, Float, Rational, and Complex use this implementation.
+  # Of the Core and Standard Library classes, Integer, Float, Rational, and
+  # Complex use this implementation.
   #
   # Related: #zero?
   #
@@ -765,8 +773,8 @@ class Numeric
   #   rdoc-file=numeric.c
   #   - to_int -> integer
   # -->
-  # Returns `self` as an integer; converts using method `to_i` in the derived
-  # class.
+  # Returns `self` as an integer; converts using method `to_i` in the subclass of
+  # Numeric. (Numeric itself does not define `to_i`.)
   #
   # Of the Core and Standard Library classes, only Rational and Complex use this
   # implementation.

data/core/object.rbs

@@ -40,7 +40,7 @@
 # *   #instance_of?: Returns whether `self` is an instance of the given class.
 # *   #instance_variable_defined?: Returns whether the given instance variable
 #     is defined in `self`.
-# *   #method: Returns the Method object for the given method in `self`.
+# *   #method: Returns the `Method` object for the given method in `self`.
 # *   #methods: Returns an array of symbol names of public and protected methods
 #     in `self`.
 # *   #nil?: Returns `false`. (Only `nil` responds `true` to method `nil?`.)
@@ -50,13 +50,13 @@
 #     methods in `self`.
 # *   #protected_methods: Returns an array of the symbol names of the protected
 #     methods in `self`.
-# *   #public_method: Returns the Method object for the given public method in
+# *   #public_method: Returns the `Method` object for the given public method in
 #     `self`.
 # *   #public_methods: Returns an array of the symbol names of the public
 #     methods in `self`.
 # *   #respond_to?: Returns whether `self` responds to the given method.
 # *   #singleton_class: Returns the singleton class of `self`.
-# *   #singleton_method: Returns the Method object for the given singleton
+# *   #singleton_method: Returns the `Method` object for the given singleton
 #     method in `self`.
 # *   #singleton_methods: Returns an array of the symbol names of the singleton
 #     methods in `self`.

data/core/object_space.rbs

@@ -29,6 +29,7 @@ module ObjectSpace
   #   - _id2ref(p1)
   # -->
   #
+  %a{deprecated}
   def self._id2ref: (Integer id) -> untyped
 
   # <!--
@@ -136,28 +137,33 @@ module ObjectSpace
   # Calls the block once for each living, nonimmediate object in this Ruby
   # process. If *module* is specified, calls the block for only those classes or
   # modules that match (or are a subclass of) *module*. Returns the number of
-  # objects found. Immediate objects (`Fixnum`s, `Symbol`s `true`, `false`, and
-  # `nil`) are never returned. In the example below, #each_object returns both the
-  # numbers we defined and several constants defined in the Math module.
+  # objects found. Immediate objects (such as `Fixnum`s, static `Symbol`s `true`,
+  # `false` and `nil`) are never returned.
   #
   # If no block is given, an enumerator is returned instead.
   #
-  #     a = 102.7
-  #     b = 95       # Won't be returned
-  #     c = 12345678987654321
-  #     count = ObjectSpace.each_object(Numeric) {|x| p x }
+  #     Job = Class.new
+  #     jobs = [Job.new, Job.new]
+  #     count = ObjectSpace.each_object(Job) {|x| p x }
   #     puts "Total count: #{count}"
   #
   # *produces:*
   #
-  #     12345678987654321
-  #     102.7
-  #     2.71828182845905
-  #     3.14159265358979
-  #     2.22044604925031e-16
-  #     1.7976931348623157e+308
-  #     2.2250738585072e-308
-  #     Total count: 7
+  #     #<Job:0x000000011d6cbbf0>
+  #     #<Job:0x000000011d6cbc68>
+  #      Total count: 2
+  #
+  # Due to a current Ractor implementation issue, this method does not yield
+  # Ractor-unshareable objects when the process is in multi-Ractor mode.
+  # Multi-ractor mode is enabled when `Ractor.new` has been called for the first
+  # time. See https://bugs.ruby-lang.org/issues/19387 for more information.
+  #
+  #     a = 12345678987654321 # shareable
+  #     b = [].freeze # shareable
+  #     c = {} # not shareable
+  #     ObjectSpace.each_object {|x| x } # yields a, b, and c
+  #     Ractor.new {} # enter multi-Ractor mode
+  #     ObjectSpace.each_object {|x| x } # does not yield c
   #
   def self.each_object: (?Module `module`) -> Enumerator[untyped, Integer]
                       | (?Module `module`) { (untyped obj) -> void } -> Integer