rbs 3.10.0.pre.2 → 3.10.0

data/core/kernel.rbs

@@ -718,7 +718,7 @@ module Kernel : BasicObject
   # variable `$?` to the process status.
   #
   # This method has potential security vulnerabilities if called with untrusted
-  # input; see [Command Injection](rdoc-ref:command_injection.rdoc).
+  # input; see [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # Examples:
   #
@@ -1118,7 +1118,7 @@ module Kernel : BasicObject
   # Returns the string resulting from formatting `objects` into `format_string`.
   #
   # For details on `format_string`, see [Format
-  # Specifications](rdoc-ref:format_specifications.rdoc).
+  # Specifications](rdoc-ref:language/format_specifications.rdoc).
   #
   def self?.format: (String format, *untyped args) -> String
 
@@ -1129,7 +1129,7 @@ module Kernel : BasicObject
   # Returns the string resulting from formatting `objects` into `format_string`.
   #
   # For details on `format_string`, see [Format
-  # Specifications](rdoc-ref:format_specifications.rdoc).
+  # Specifications](rdoc-ref:language/format_specifications.rdoc).
   #
   alias sprintf format
 
@@ -1249,7 +1249,7 @@ module Kernel : BasicObject
   # Creates an IO object connected to the given file.
   #
   # This method has potential security vulnerabilities if called with untrusted
-  # input; see [Command Injection](rdoc-ref:command_injection.rdoc).
+  # input; see [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # With no block given, file stream is returned:
   #
@@ -1327,7 +1327,7 @@ module Kernel : BasicObject
   #     io.write(sprintf(format_string, *objects))
   #
   # For details on `format_string`, see [Format
-  # Specifications](rdoc-ref:format_specifications.rdoc).
+  # Specifications](rdoc-ref:language/format_specifications.rdoc).
   #
   # With the single argument `format_string`, formats `objects` into the string,
   # then writes the formatted string to $stdout:
@@ -1907,7 +1907,7 @@ module Kernel : BasicObject
   # *   Invoking the executable at `exe_path`.
   #
   # This method has potential security vulnerabilities if called with untrusted
-  # input; see [Command Injection](rdoc-ref:command_injection.rdoc).
+  # input; see [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # The new process is created using the [exec system
   # call](https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/functions/e
@@ -1999,7 +1999,7 @@ module Kernel : BasicObject
   # *   Invoking the executable at `exe_path`.
   #
   # This method has potential security vulnerabilities if called with untrusted
-  # input; see [Command Injection](rdoc-ref:command_injection.rdoc).
+  # input; see [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # Returns the process ID (pid) of the new process, without waiting for it to
   # complete.
@@ -2102,7 +2102,7 @@ module Kernel : BasicObject
   # *   Invoking the executable at `exe_path`.
   #
   # This method has potential security vulnerabilities if called with untrusted
-  # input; see [Command Injection](rdoc-ref:command_injection.rdoc).
+  # input; see [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # Returns:
   #

data/core/module.rbs

@@ -135,14 +135,25 @@ class Module < Object
 
   # <!--
   #   rdoc-file=object.c
-  #   - module <=> other_module   -> -1, 0, +1, or nil
+  #   - self <=> object -> -1, 0, +1, or nil
   # -->
-  # Comparison---Returns -1, 0, +1 or nil depending on whether `module` includes
-  # `other_module`, they are the same, or if `module` is included by
-  # `other_module`.
+  # Returns:
   #
-  # Returns `nil` if `module` has no relationship with `other_module`, if
-  # `other_module` is not a module, or if the two values are incomparable.
+  # *   `-1`, if `self` includes `object`, if or `self` is a subclass of `object`.
+  # *   `0`, if `self` and `object` are the same.
+  # *   `1`, if `object` includes `self`, or if `object` is a subclass of `self`.
+  # *   `nil`, if none of the above is true.
+  #
+  # Examples:
+  #
+  #     # Class Array includes module Enumerable.
+  #              Array <=> Enumerable # => -1
+  #         Enumerable <=> Enumerable # =>  0
+  #         Enumerable <=> Array      # =>  1
+  #     # Class File is a subclass of class IO.
+  #               File <=> IO         # => -1
+  #                 IO <=> File       # =>  1
+  #               File <=> File       # =>  0
   #
   def <=>: (untyped other) -> Integer?
 

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
 
@@ -336,7 +336,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 +398,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 +488,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 +765,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

@@ -712,6 +712,7 @@ class Pathname
   #   rdoc-file=pathname_builtin.rb
   #   - freeze()
   # -->
+  # Freze self.
   #
   def freeze: () -> Pathname
 
@@ -1154,9 +1155,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/ractor.rbs

@@ -382,7 +382,7 @@ class Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.sharable_proc(self: nil){} -> sharable proc
+  #   - Ractor.shareable_proc(self: nil){} -> shareable proc
   # -->
   # It returns shareable Proc object. The Proc object is shareable and the self in
   # a block will be replaced with the value passed via `self:` keyword.
@@ -393,7 +393,7 @@ class Ractor
   #     Ractor.shareable_proc{ p a }
   #     #=> can not isolate a Proc because it accesses outer variables (a). (ArgumentError)
   #
-  # The `self` should be a sharable object
+  # The `self` should be a shareable object
   #
   #     Ractor.shareable_proc(self: self){}
   #     #=> self should be shareable: main (Ractor::IsolationError)
@@ -403,9 +403,9 @@ class Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.sharable_proc{} -> sharable proc
+  #   - Ractor.shareable_proc{} -> shareable proc
   # -->
-  # Same as Ractor.sharable_proc, but returns lambda proc.
+  # Same as Ractor.shareable_proc, but returns lambda proc.
   #
   def self.shareable_lambda: [T] () { (?) [self: nil] -> T } -> ^(?) [self: nil] -> T
                            | [T, S] (self: S) { (?) [self: S] -> T } -> ^(?) [self: S] -> T

data/core/range.rbs

@@ -351,7 +351,7 @@ class Range[out Elem] < Object
   # -->
   # Returns an element from `self` selected by a binary search.
   #
-  # See [Binary Searching](rdoc-ref:bsearch.rdoc).
+  # See [Binary Searching](rdoc-ref:language/bsearch.rdoc).
   #
   def bsearch: () -> ::Enumerator[Elem, Elem?]
              | () { (Elem) -> (true | false) } -> Elem?

data/core/rational.rbs

@@ -53,15 +53,16 @@ class Rational < Numeric
 
   # <!--
   #   rdoc-file=rational.c
-  #   - rat * numeric  ->  numeric
+  #   - self * other -> numeric
   # -->
-  # Performs multiplication.
+  # Returns the numeric product of `self` and `other`:
   #
-  #     Rational(2, 3)  * Rational(2, 3)   #=> (4/9)
-  #     Rational(900)   * Rational(1)      #=> (900/1)
-  #     Rational(-2, 9) * Rational(-9, 2)  #=> (1/1)
-  #     Rational(9, 8)  * 4                #=> (9/2)
-  #     Rational(20, 9) * 9.8              #=> 21.77777777777778
+  #     Rational(9, 8)  * 4               #=> (9/2)
+  #     Rational(20, 9) * 9.8             #=> 21.77777777777778
+  #     Rational(9, 8)  * Complex(1, 2)   # => ((9/8)+(9/4)*i)
+  #     Rational(2, 3)  * Rational(2, 3)  #=> (4/9)
+  #     Rational(900)   * Rational(1)     #=> (900/1)
+  #     Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
   #
   def *: (Integer) -> Rational
        | (Rational) -> Rational
@@ -69,9 +70,9 @@ class Rational < Numeric
 
   # <!--
   #   rdoc-file=rational.c
-  #   - rat ** numeric  ->  numeric
+  #   - self ** exponent -> numeric
   # -->
-  # Performs exponentiation.
+  # Returns `self` raised to the power `exponent`:
   #
   #     Rational(2)    ** Rational(3)     #=> (8/1)
   #     Rational(10)   ** -2              #=> (1/100)
@@ -85,15 +86,25 @@ class Rational < Numeric
 
   # <!--
   #   rdoc-file=rational.c
-  #   - rat + numeric  ->  numeric
+  #   - self + other -> numeric
   # -->
-  # Performs addition.
+  # Returns the sum of `self` and `other`:
   #
-  #     Rational(2, 3)  + Rational(2, 3)   #=> (4/3)
-  #     Rational(900)   + Rational(1)      #=> (901/1)
-  #     Rational(-2, 9) + Rational(-9, 2)  #=> (-85/18)
-  #     Rational(9, 8)  + 4                #=> (41/8)
-  #     Rational(20, 9) + 9.8              #=> 12.022222222222222
+  #     Rational(2, 3) + 0  # => (2/3)
+  #     Rational(2, 3) + 1  # => (5/3)
+  #     Rational(2, 3) + -1 # => (-1/3)
+  #
+  #     Rational(2, 3) + Complex(1, 0)     # => ((5/3)+0i)
+  #
+  #     Rational(2, 3) + Rational(1, 1)     # => (5/3)
+  #     Rational(2, 3) + Rational(3, 2)     # => (13/6)
+  #     Rational(2, 3) + Rational(3.0, 2.0) # => (13/6)
+  #     Rational(2, 3) + Rational(3.1, 2.1) # => (30399297484750849/14186338826217063)
+  #
+  # For a computation involving Floats, the result may be inexact (see Float#+):
+  #
+  #     Rational(2, 3) + 1.0 # => 1.6666666666666665
+  #     Rational(2, 3) + Complex(1.0, 0.0) # => (1.6666666666666665+0.0i)
   #
   def +: (Float) -> Float
        | (Complex) -> Complex
@@ -103,9 +114,9 @@ class Rational < Numeric
 
   # <!--
   #   rdoc-file=rational.c
-  #   - rat - numeric  ->  numeric
+  #   - self - other -> numeric
   # -->
-  # Performs subtraction.
+  # Returns the difference of `self` and `other`:
   #
   #     Rational(2, 3)  - Rational(2, 3)   #=> (0/1)
   #     Rational(900)   - Rational(1)      #=> (899/1)
@@ -119,18 +130,20 @@ class Rational < Numeric
 
   # <!--
   #   rdoc-file=rational.c
-  #   - -rat  ->  rational
+  #   - -self -> rational
   # -->
-  # Negates `rat`.
+  # Returns `self`, negated:
+  #
+  #     -(1/3r)   # => (-1/3)
+  #     -(-1/3r)  # => (1/3)
   #
   def -@: () -> Rational
 
   # <!--
   #   rdoc-file=rational.c
-  #   - rat / numeric     ->  numeric
-  #   - rat.quo(numeric)  ->  numeric
+  #   - self / other -> numeric
   # -->
-  # Performs division.
+  # Returns the quotient of `self` and `other`:
   #
   #     Rational(2, 3)  / Rational(2, 3)   #=> (1/1)
   #     Rational(900)   / Rational(1)      #=> (900/1)
@@ -364,7 +377,7 @@ class Rational < Numeric
   def positive?: () -> bool
 
   # <!-- rdoc-file=rational.c -->
-  # Performs division.
+  # Returns the quotient of `self` and `other`:
   #
   #     Rational(2, 3)  / Rational(2, 3)   #=> (1/1)
   #     Rational(900)   / Rational(1)      #=> (900/1)

data/core/rbs/unnamed/argf.rbs

@@ -836,7 +836,7 @@ module RBS
       # Formats and writes `objects` to the stream.
       #
       # For details on `format_string`, see [Format
-      # Specifications](rdoc-ref:format_specifications.rdoc).
+      # Specifications](rdoc-ref:language/format_specifications.rdoc).
       #
       %a{annotate:rdoc:copy:ARGF#printf}
       def printf: (String format_string, *untyped args) -> nil

data/core/regexp.rbs

@@ -39,7 +39,7 @@
 #     most such methods accept an argument that may be either a string or the
 #     (much more powerful) regexp.
 #
-#     See [Regexp Methods](rdoc-ref:regexp/methods.rdoc).
+#     See [Regexp Methods](rdoc-ref:language/regexp/methods.rdoc).
 #
 # ## Regexp Objects
 #
@@ -821,8 +821,8 @@
 #     /\P{Alpha}/.match('1') # => #<MatchData "1">
 #     /\P{Alpha}/.match('a') # => nil
 #
-# See [Unicode Properties](rdoc-ref:regexp/unicode_properties.rdoc) for regexps
-# based on the numerous properties.
+# See [Unicode Properties](rdoc-ref:language/regexp/unicode_properties.rdoc) for
+# regexps based on the numerous properties.
 #
 # Some commonly-used properties correspond to POSIX bracket expressions:
 #

data/core/ruby.rbs

@@ -0,0 +1,53 @@
+# <!-- rdoc-file=version.c -->
+# The [Ruby](rdoc-ref:Ruby) module that contains portable information among
+# implementations.
+#
+# The constants defined here are aliased in the toplevel with `RUBY_` prefix.
+#
+module Ruby
+  # <!-- rdoc-file=version.c -->
+  # The copyright string for ruby
+  #
+  COPYRIGHT: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The full ruby version string, like `ruby -v` prints
+  #
+  DESCRIPTION: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The engine or interpreter this ruby uses.
+  #
+  ENGINE: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The version of the engine or interpreter this ruby uses.
+  #
+  ENGINE_VERSION: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The patchlevel for this ruby.  If this is a development build of ruby the
+  # patchlevel will be -1
+  #
+  PATCHLEVEL: ::Integer
+
+  # <!-- rdoc-file=version.c -->
+  # The platform for this ruby
+  #
+  PLATFORM: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The date this ruby was released
+  #
+  RELEASE_DATE: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The GIT commit hash for this ruby.
+  #
+  REVISION: ::String
+
+  # <!-- rdoc-file=version.c -->
+  # The running version of ruby
+  #
+  VERSION: ::String
+end

data/core/rubygems/version.rbs

@@ -180,7 +180,6 @@ module Gem
     #
     #     ver1 = Version.create('1.3.17')   # -> (Version object)
     #     ver2 = Version.create(ver1)       # -> (ver1)
-    #     ver3 = Version.create(nil)        # -> nil
     #
     def self.create: (_ToS | Version input) -> instance
                    | (nil input) -> nil
@@ -199,8 +198,8 @@ module Gem
     #   - <=>(other)
     # -->
     # Compares this version with `other` returning -1, 0, or 1 if the other version
-    # is larger, the same, or smaller than this one. Attempts to compare to
-    # something that's not a `Gem::Version` or a valid version String return `nil`.
+    # is larger, the same, or smaller than this one. `other` must be an instance of
+    # Gem::Version, comparing with other types may raise an exception.
     #
     def <=>: (untyped other) -> Integer?