rbs 3.9.4 → 3.10.2

data/core/integer.rbs

@@ -146,9 +146,9 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self % other -> real_number
+  #   - self % other -> real_numeric
   # -->
-  # Returns `self` modulo `other` as a real number.
+  # Returns `self` modulo `other` as a real numeric (Integer, Float, or Rational).
   #
   # For integer `n` and real number `r`, these expressions are equivalent:
   #
@@ -193,13 +193,13 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self * numeric -> numeric_result
+  #   - self * other -> numeric
   # -->
-  # Performs multiplication:
+  # Returns the numeric product of `self` and `other`:
   #
   #     4 * 2              # => 8
-  #     4 * -2             # => -8
   #     -4 * 2             # => -8
+  #     4 * -2             # => -8
   #     4 * 2.0            # => 8.0
   #     4 * Rational(1, 3) # => (4/3)
   #     4 * Complex(2, 0)  # => (8+0i)
@@ -211,17 +211,47 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self ** numeric -> numeric_result
+  #   - self ** exponent -> numeric
   # -->
-  # Raises `self` to the power of `numeric`:
-  #
-  #     2 ** 3              # => 8
-  #     2 ** -3             # => (1/8)
-  #     -2 ** 3             # => -8
-  #     -2 ** -3            # => (-1/8)
-  #     2 ** 3.3            # => 9.849155306759329
-  #     2 ** Rational(3, 1) # => (8/1)
-  #     2 ** Complex(3, 0)  # => (8+0i)
+  # Returns `self` raised to the power `exponent`:
+  #
+  #     # Result for non-negative Integer exponent is Integer.
+  #     2 ** 0   # => 1
+  #     2 ** 1   # => 2
+  #     2 ** 2   # => 4
+  #     2 ** 3   # => 8
+  #     -2 ** 3  # => -8
+  #     # Result for negative Integer exponent is Rational, not Float.
+  #     2 ** -3  # => (1/8)
+  #     -2 ** -3 # => (-1/8)
+  #
+  #     # Result for Float exponent is Float.
+  #     2 ** 0.0   # => 1.0
+  #     2 ** 1.0   # => 2.0
+  #     2 ** 2.0   # => 4.0
+  #     2 ** 3.0   # => 8.0
+  #     -2 ** 3.0  # => -8.0
+  #     2 ** -3.0  # => 0.125
+  #     -2 ** -3.0 # => -0.125
+  #
+  #     # Result for non-negative Complex exponent is Complex with Integer parts.
+  #     2 ** Complex(0, 0)   # => (1+0i)
+  #     2 ** Complex(1, 0)   # => (2+0i)
+  #     2 ** Complex(2, 0)   # => (4+0i)
+  #     2 ** Complex(3, 0)   # => (8+0i)
+  #     -2 ** Complex(3, 0) # => (-8+0i)
+  #     # Result for negative Complex exponent is Complex with Rational parts.
+  #     2 ** Complex(-3, 0)  # => ((1/8)+(0/1)*i)
+  #     -2 ** Complex(-3, 0) # => ((-1/8)+(0/1)*i)
+  #
+  #     # Result for Rational exponent is Rational.
+  #     2 ** Rational(0, 1)   # => (1/1)
+  #     2 ** Rational(1, 1)   # => (2/1)
+  #     2 ** Rational(2, 1)   # => (4/1)
+  #     2 ** Rational(3, 1)   # => (8/1)
+  #     -2 ** Rational(3, 1)  # => (-8/1)
+  #     2 ** Rational(-3, 1)  # => (1/8)
+  #     -2 ** Rational(-3, 1) # => (-1/8)
   #
   def **: (Integer) -> Numeric
         | (Float) -> Numeric
@@ -230,16 +260,20 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self + numeric -> numeric_result
+  #   - self + other -> numeric
   # -->
-  # Performs addition:
+  # Returns the sum of `self` and `other`:
+  #
+  #     1 + 1               # => 2
+  #     1 + -1             # => 0
+  #     1 + 0              # => 1
+  #     1 + -2             # => -1
+  #     1 + Complex(1, 0)  # => (2+0i)
+  #     1 + Rational(1, 1) # => (2/1)
+  #
+  # For a computation involving Floats, the result may be inexact (see Float#+):
   #
-  #     2 + 2              # => 4
-  #     -2 + 2             # => 0
-  #     -2 + -2            # => -4
-  #     2 + 2.0            # => 4.0
-  #     2 + Rational(2, 1) # => (4/1)
-  #     2 + Complex(2, 0)  # => (4+0i)
+  #     1 + 3.14           # => 4.140000000000001
   #
   def +: (Integer) -> Integer
        | (Float) -> Float
@@ -250,9 +284,9 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self - numeric -> numeric_result
+  #   - self - other -> numeric
   # -->
-  # Performs subtraction:
+  # Returns the difference of `self` and `other`:
   #
   #     4 - 2              # => 2
   #     -4 - 2             # => -6
@@ -268,28 +302,34 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - -int -> integer
+  #   - -self -> integer
   # -->
-  # Returns `self`, negated.
+  # Returns `self`, negated:
+  #
+  #     -1    # => -1
+  #     -(-1) # => 1
+  #     -0    # => 0
   #
   def -@: () -> Integer
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self / numeric -> numeric_result
+  #   - self / other -> numeric
   # -->
-  # Performs division; for integer `numeric`, truncates the result to an integer:
+  # Returns the quotient of `self` and `other`.
+  #
+  # For integer `other`, truncates the result to an integer:
   #
-  #      4 / 3              # => 1
-  #      4 / -3             # => -2
-  #      -4 / 3             # => -2
-  #      -4 / -3            # => 1
+  #     4 / 3              # => 1
+  #     4 / -3             # => -2
+  #     -4 / 3             # => -2
+  #     -4 / -3            # => 1
   #
-  #     For other +numeric+, returns non-integer result:
+  # For non-integer `other`, returns a non-integer result:
   #
-  #      4 / 3.0            # => 1.3333333333333333
-  #      4 / Rational(3, 1) # => (4/3)
-  #      4 / Complex(3, 0)  # => ((4/3)+0i)
+  #     4 / 3.0            # => 1.3333333333333333
+  #     4 / Rational(3, 1) # => (4/3)
+  #     4 / Complex(3, 0)  # => ((4/3)+0i)
   #
   def /: (Integer) -> Integer
        | (Float) -> Float
@@ -300,15 +340,14 @@ class Integer < Numeric
   #   rdoc-file=numeric.c
   #   - self < other -> true or false
   # -->
-  # Returns `true` if the value of `self` is less than that of `other`:
+  # Returns whether the value of `self` is less than the value of `other`; `other`
+  # must be numeric, but may not be Complex:
   #
-  #       1 < 0              # => false
-  #       1 < 1              # => false
-  #       1 < 2              # => true
-  #       1 < 0.5            # => false
-  #       1 < Rational(1, 2) # => false
-  #
-  #     Raises an exception if the comparison cannot be made.
+  #     1 < 0              # => false
+  #     1 < 1              # => false
+  #     1 < 2              # => true
+  #     1 < 0.5            # => false
+  #     1 < Rational(1, 2) # => false
   #
   def <: (Numeric) -> bool
 
@@ -331,44 +370,46 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self <= real -> true or false
+  #   - self <= other -> true or false
   # -->
-  # Returns `true` if the value of `self` is less than or equal to that of
-  # `other`:
+  # Returns whether the value of `self` is less than or equal to the value of
+  # `other`; `other` must be numeric, but may not be Complex:
   #
-  #     1 <= 0              # => false
-  #     1 <= 1              # => true
-  #     1 <= 2              # => true
-  #     1 <= 0.5            # => false
-  #     1 <= Rational(1, 2) # => false
+  #       1 <= 0              # => false
+  #       1 <= 1              # => true
+  #       1 <= 2              # => true
+  #       1 <= 0.5            # => false
+  #       1 <= Rational(1, 2) # => false
   #
-  # Raises an exception if the comparison cannot be made.
+  #     Raises an exception if the comparison cannot be made.
   #
   def <=: (Numeric) -> bool
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self <=> other  ->  -1, 0, +1, or nil
+  #   - self <=> other -> -1, 0, 1, or nil
   # -->
+  # Compares `self` and `other`.
+  #
   # Returns:
   #
-  # *   -1, if `self` is less than `other`.
-  # *   0, if `self` is equal to `other`.
-  # *   1, if `self` is greater then `other`.
+  # *   `-1`, if `self` is less than `other`.
+  # *   `0`, if `self` is equal to `other`.
+  # *   `1`, if `self` is greater then `other`.
   # *   `nil`, if `self` and `other` are incomparable.
   #
   # Examples:
   #
   #     1 <=> 2              # => -1
   #     1 <=> 1              # => 0
-  #     1 <=> 0              # => 1
-  #     1 <=> 'foo'          # => nil
-  #
   #     1 <=> 1.0            # => 0
   #     1 <=> Rational(1, 1) # => 0
   #     1 <=> Complex(1, 0)  # => 0
+  #     1 <=> 0              # => 1
+  #     1 <=> 'foo'          # => nil
   #
-  # This method is the basis for comparisons in module Comparable.
+  # Class Integer includes module Comparable, each of whose methods uses
+  # Integer#<=> for comparison.
   #
   def <=>: (Integer | Rational) -> Integer
          | (untyped) -> Integer?
@@ -955,7 +996,7 @@ class Integer < Numeric
   def magnitude: () -> Integer
 
   # <!-- rdoc-file=numeric.c -->
-  # Returns `self` modulo `other` as a real number.
+  # Returns `self` modulo `other` as a real numeric (Integer, Float, or Rational).
   #
   # For integer `n` and real number `r`, these expressions are equivalent:
   #

data/core/io/buffer.rbs

@@ -64,9 +64,9 @@ class IO
   #
   #     File.write('test.txt', 'test data')
   #     # => 9
-  #     buffer = IO::Buffer.map(File.open('test.txt'))
+  #     buffer = IO::Buffer.map(File.open('test.txt'), nil, 0, IO::Buffer::READONLY)
   #     # =>
-  #     # #<IO::Buffer 0x00007f3f0768c000+9 MAPPED IMMUTABLE>
+  #     # #<IO::Buffer 0x00007f3f0768c000+9 EXTERNAL MAPPED FILE SHARED READONLY>
   #     # ...
   #     buffer.get_string(5, 2) # read 2 bytes, starting from offset 5
   #     # => "da"
@@ -113,7 +113,7 @@ class IO
     #     buffer.get_string(0, 1)
     #     # => "t"
     #     string
-    #     # => "best"
+    #     # => "test"
     #
     #     buffer.resize(100)
     #     # in `resize': Cannot resize external buffer! (IO::Buffer::AccessError)
@@ -131,18 +131,25 @@ class IO
     #   - IO::Buffer.map(file, [size, [offset, [flags]]]) -> io_buffer
     # -->
     # Create an IO::Buffer for reading from `file` by memory-mapping the file.
-    # `file_io` should be a `File` instance, opened for reading.
+    # `file` should be a `File` instance, opened for reading or reading and writing.
+    #
+    # Optional `size` and `offset` of mapping can be specified. Trying to map an
+    # empty file or specify `size` of 0 will raise an error. Valid values for
+    # `offset` are system-dependent.
     #
-    # Optional `size` and `offset` of mapping can be specified.
+    # By default, the buffer is writable and expects the file to be writable. It is
+    # also shared, so several processes can use the same mapping.
     #
-    # By default, the buffer would be immutable (read only); to create a writable
-    # mapping, you need to open a file in read-write mode, and explicitly pass
-    # `flags` argument without IO::Buffer::IMMUTABLE.
+    # You can pass IO::Buffer::READONLY in `flags` argument to make a read-only
+    # buffer; this allows to work with files opened only for reading. Specifying
+    # IO::Buffer::PRIVATE in `flags` creates a private mapping, which will not
+    # impact other processes or the underlying file. It also allows updating a
+    # buffer created from a read-only file.
     #
     #     File.write('test.txt', 'test')
     #
     #     buffer = IO::Buffer.map(File.open('test.txt'), nil, 0, IO::Buffer::READONLY)
-    #     # => #<IO::Buffer 0x00000001014a0000+4 MAPPED READONLY>
+    #     # => #<IO::Buffer 0x00000001014a0000+4 EXTERNAL MAPPED FILE SHARED READONLY>
     #
     #     buffer.readonly?   # => true
     #
@@ -150,7 +157,7 @@ class IO
     #     # => "test"
     #
     #     buffer.set_string('b', 0)
-    #     # `set_string': Buffer is not writable! (IO::Buffer::AccessError)
+    #     # 'IO::Buffer#set_string': Buffer is not writable! (IO::Buffer::AccessError)
     #
     #     # create read/write mapping: length 4 bytes, offset 0, flags 0
     #     buffer = IO::Buffer.map(File.open('test.txt', 'r+'), 4, 0)
@@ -382,6 +389,10 @@ class IO
     # *   `:U64`: unsigned integer, 8 bytes, big-endian
     # *   `:s64`: signed integer, 8 bytes, little-endian
     # *   `:S64`: signed integer, 8 bytes, big-endian
+    # *   `:u128`: unsigned integer, 16 bytes, little-endian
+    # *   `:U128`: unsigned integer, 16 bytes, big-endian
+    # *   `:s128`: signed integer, 16 bytes, little-endian
+    # *   `:S128`: signed integer, 16 bytes, big-endian
     # *   `:f32`: float, 4 bytes, little-endian
     # *   `:F32`: float, 4 bytes, big-endian
     # *   `:f64`: double, 8 bytes, little-endian

data/core/io/wait.rbs

@@ -1,30 +1,9 @@
 %a{annotate:rdoc:skip}
 class IO
   # <!--
-  #   rdoc-file=ext/io/wait/wait.c
-  #   - io.nread -> int
-  # -->
-  # Returns number of bytes that can be read without blocking. Returns zero if no
-  # information available.
-  #
-  # You must require 'io/wait' to use this method.
-  #
-  def nread: () -> Integer
-
-  # <!--
-  #   rdoc-file=ext/io/wait/wait.c
-  #   - io.ready? -> truthy or falsy
-  # -->
-  # Returns a truthy value if input available without blocking, or a falsy value.
-  #
-  # You must require 'io/wait' to use this method.
-  #
-  def ready?: () -> boolish
-
-  # <!--
-  #   rdoc-file=ext/io/wait/wait.c
+  #   rdoc-file=io.c
   #   - io.wait(events, timeout) -> event mask, false or nil
-  #   - io.wait(timeout = nil, mode = :read) -> self, true, or false
+  #   - io.wait(*event_symbols[, timeout]) -> self, true, or false
   # -->
   # Waits until the IO becomes ready for the specified events and returns the
   # subset of events that become ready, or a falsy value when times out.
@@ -32,11 +11,14 @@ class IO
   # The events can be a bit mask of `IO::READABLE`, `IO::WRITABLE` or
   # `IO::PRIORITY`.
   #
-  # Returns a truthy value immediately when buffered data is available.
-  #
-  # Optional parameter `mode` is one of `:read`, `:write`, or `:read_write`.
+  # Returns an event mask (truthy value) immediately when buffered data is
+  # available.
   #
-  # You must require 'io/wait' to use this method.
+  # The second form: if one or more event symbols (`:read`, `:write`, or
+  # `:read_write`) are passed, the event mask is the bit OR of the bitmask
+  # corresponding to those symbols.  In this form, `timeout` is optional, the
+  # order of the arguments is arbitrary, and returns `io` if any of the events is
+  # ready.
   #
   def wait: (Integer events, ?Time::_Timeout timeout) -> (Integer | false | nil)
           | (?Time::_Timeout? timeout, *wait_mode mode) -> (self | true | false)
@@ -44,7 +26,7 @@ class IO
   type wait_mode = :read | :r | :readable | :write | :w | :writable | :read_write | :rw | :readable_writable
 
   # <!--
-  #   rdoc-file=ext/io/wait/wait.c
+  #   rdoc-file=io.c
   #   - io.wait_readable          -> truthy or falsy
   #   - io.wait_readable(timeout) -> truthy or falsy
   # -->
@@ -52,19 +34,15 @@ class IO
   # times out.  Returns a truthy value immediately when buffered data is
   # available.
   #
-  # You must require 'io/wait' to use this method.
-  #
   def wait_readable: (?Time::_Timeout? timeout) -> boolish
 
   # <!--
-  #   rdoc-file=ext/io/wait/wait.c
+  #   rdoc-file=io.c
   #   - io.wait_writable          -> truthy or falsy
   #   - io.wait_writable(timeout) -> truthy or falsy
   # -->
   # Waits until IO is writable and returns a truthy value or a falsy value when
   # times out.
   #
-  # You must require 'io/wait' to use this method.
-  #
   def wait_writable: (?Time::_Timeout? timeout) -> boolish
 end

data/core/io.rbs

@@ -1373,7 +1373,7 @@ class IO < Object
   # 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).
   #
   def printf: (String format_string, *untyped objects) -> nil
 
@@ -2276,7 +2276,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   def self.binread: (String name, ?Integer? length, ?Integer offset) -> String
 
@@ -2289,7 +2289,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   def self.binwrite: (String name, _ToS string, ?Integer offset, ?mode: String mode) -> Integer
 
@@ -2354,15 +2354,16 @@ class IO < Object
   # connected to a new stream `io`.
   #
   # 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).
   #
   # If no block is given, returns the new stream, which depending on given `mode`
   # may be open for reading, writing, or both. The stream should be explicitly
   # closed (eventually) to avoid resource leaks.
   #
   # If a block is given, the stream is passed to the block (again, open for
-  # reading, writing, or both); when the block exits, the stream is closed, and
-  # the block's value is assigned to global variable `$?` and returned.
+  # reading, writing, or both); when the block exits, the stream is closed, the
+  # block's value is returned, and the global variable `$?` is set to the child's
+  # exit status.
   #
   # Optional argument `mode` may be any valid IO mode. See [Access
   # Modes](rdoc-ref:File@Access+Modes).
@@ -2391,7 +2392,7 @@ class IO < Object
   # *   [Encoding options](rdoc-ref:encodings.rdoc@Encoding+Options).
   # *   Options for Kernel#spawn.
   #
-  # **Forked \Process**
+  # **Forked Process**
   #
   # When argument `cmd` is the 1-character string `'-'`, causes the process to
   # fork:
@@ -2528,7 +2529,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # The first argument must be a string that is the path to a file.
   #
@@ -2685,7 +2686,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # The first argument must be a string that is the path to a file.
   #
@@ -2728,7 +2729,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # The first argument must be a string that is the path to a file.
   #
@@ -2785,7 +2786,8 @@ class IO < Object
   # IO objects.
   #
   # Argument `timeout` is a numeric value (such as integer or float) timeout
-  # interval in seconds.
+  # interval in seconds. `timeout` can also be `nil` or `Float::INFINITY`. `nil`
+  # and `Float::INFINITY` means no timeout.
   #
   # The method monitors the IO objects given in all three arrays, waiting for some
   # to be ready; returns a 3-element array whose elements are:
@@ -2952,7 +2954,7 @@ class IO < Object
   #
   # When called from class IO (but not subclasses of IO), this method has
   # potential security vulnerabilities if called with untrusted input; see
-  # [Command Injection](rdoc-ref:command_injection.rdoc).
+  # [Command Injection](rdoc-ref:security/command_injection.rdoc).
   #
   # The first argument must be a string that is the path to a file.
   #