rbs 3.10.0.pre.2 → 3.10.1

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.
@@ -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_space.rbs

@@ -137,33 +137,26 @@ 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
-  #
-  # Due to a current known Ractor implementation issue, this method will not yield
-  # Ractor-unshareable objects in multi-Ractor mode (when `Ractor.new` has been
-  # called within the process at least once). See
-  # https://bugs.ruby-lang.org/issues/19387 for more information.
+  #     #<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

data/core/pathname.rbs

@@ -670,28 +670,6 @@ class Pathname
   #
   def file?: () -> bool
 
-  # <!--
-  #   rdoc-file=lib/pathname.rb
-  #   - find(ignore_error: true) { |pathname| ... }
-  # -->
-  # Iterates over the directory tree in a depth first manner, yielding a Pathname
-  # for each file under "this" directory.
-  #
-  # Note that you need to require 'pathname' to use this method.
-  #
-  # Returns an Enumerator if no block is given.
-  #
-  # Since it is implemented by the standard library module Find, Find.prune can be
-  # used to control the traversal.
-  #
-  # If `self` is `.`, yielded pathnames begin with a filename in the current
-  # directory, not `./`.
-  #
-  # See Find.find
-  #
-  def find: (?ignore_error: boolish) { (Pathname) -> untyped } -> nil
-          | (?ignore_error: boolish) -> Enumerator[Pathname, nil]
-
   # <!--
   #   rdoc-file=pathname_builtin.rb
   #   - fnmatch(pattern, ...)
@@ -712,6 +690,7 @@ class Pathname
   #   rdoc-file=pathname_builtin.rb
   #   - freeze()
   # -->
+  # Freze self.
   #
   def freeze: () -> Pathname
 
@@ -1016,18 +995,6 @@ class Pathname
   #
   def rmdir: () -> 0
 
-  # <!--
-  #   rdoc-file=lib/pathname.rb
-  #   - rmtree(noop: nil, verbose: nil, secure: nil)
-  # -->
-  # Recursively deletes a directory, including all directories beneath it.
-  #
-  # Note that you need to require 'pathname' to use this method.
-  #
-  # See FileUtils.rm_rf
-  #
-  def rmtree: () -> self
-
   # <!--
   #   rdoc-file=pathname_builtin.rb
   #   - root?()
@@ -1154,9 +1121,7 @@ class Pathname
   #
   def taint: () -> Pathname
 
-  # <!-- rdoc-file=ext/pathname/pathname.c -->
-  # Return the path as a String.
-  #
+  # <!-- rdoc-file=pathname_builtin.rb -->
   # to_path is implemented so Pathname objects are usable with File.open, etc.
   #
   def to_path: () -> String

data/core/proc.rbs

@@ -380,9 +380,9 @@ class Proc
   def dup: () -> self
 
   # <!-- rdoc-file=proc.c -->
-  # Invokes the block, setting the block's parameters to the values in *params*
-  # using something close to method calling semantics. Returns the value of the
-  # last expression evaluated in the block.
+  # Invokes the block, setting the block's parameters to the arguments using
+  # something close to method calling semantics. Returns the value of the last
+  # expression evaluated in the block.
   #
   #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
   #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]
@@ -409,9 +409,9 @@ class Proc
   alias === call
 
   # <!-- rdoc-file=proc.c -->
-  # Invokes the block, setting the block's parameters to the values in *params*
-  # using something close to method calling semantics. Returns the value of the
-  # last expression evaluated in the block.
+  # Invokes the block, setting the block's parameters to the arguments using
+  # something close to method calling semantics. Returns the value of the last
+  # expression evaluated in the block.
   #
   #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
   #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]
@@ -592,14 +592,13 @@ class Proc
 
   # <!--
   #   rdoc-file=proc.c
-  #   - prc.call(params,...)   -> obj
-  #   - prc[params,...]        -> obj
-  #   - prc.(params,...)       -> obj
-  #   - prc.yield(params,...)  -> obj
+  #   - call(...) -> obj
+  #   - self[...] -> obj
+  #   - yield(...) -> obj
   # -->
-  # Invokes the block, setting the block's parameters to the values in *params*
-  # using something close to method calling semantics. Returns the value of the
-  # last expression evaluated in the block.
+  # Invokes the block, setting the block's parameters to the arguments using
+  # something close to method calling semantics. Returns the value of the last
+  # expression evaluated in the block.
   #
   #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
   #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]
@@ -626,9 +625,9 @@ class Proc
   def call: (?) -> untyped
 
   # <!-- rdoc-file=proc.c -->
-  # Invokes the block, setting the block's parameters to the values in *params*
-  # using something close to method calling semantics. Returns the value of the
-  # last expression evaluated in the block.
+  # Invokes the block, setting the block's parameters to the arguments using
+  # something close to method calling semantics. Returns the value of the last
+  # expression evaluated in the block.
   #
   #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
   #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]