rbs 3.3.2 → 3.4.0

data/core/enumerable.rbs

@@ -5,7 +5,8 @@
 #
 # *   [Querying](rdoc-ref:Enumerable@Methods+for+Querying)
 # *   [Fetching](rdoc-ref:Enumerable@Methods+for+Fetching)
-# *   [Searching](rdoc-ref:Enumerable@Methods+for+Searching)
+# *   [Searching and
+#     Filtering](rdoc-ref:Enumerable@Methods+for+Searching+and+Filtering)
 # *   [Sorting](rdoc-ref:Enumerable@Methods+for+Sorting)
 # *   [Iterating](rdoc-ref:Enumerable@Methods+for+Iterating)
 # *   [And more....](rdoc-ref:Enumerable@Other+Methods)
@@ -210,6 +211,8 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # -->
   # Returns whether every element meets a given criterion.
   #
+  # If `self` has no element, returns `true` and argument or block are not used.
+  #
   # With no argument and no block, returns whether every element is truthy:
   #
   #     (1..4).all?           # => true
@@ -252,6 +255,8 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   # -->
   # Returns whether any element meets a given criterion.
   #
+  # If `self` has no element, returns `false` and argument or block are not used.
+  #
   # With no argument and no block, returns whether any element is truthy:
   #
   #     (1..4).any?          # => true
@@ -521,8 +526,6 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #
   #     (0..4).to_a # => [0, 1, 2, 3, 4]
   #
-  # Enumerable#entries is an alias for Enumerable#to_a.
-  #
   def entries: () -> ::Array[Elem]
 
   # <!--
@@ -721,8 +724,6 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #     {foo: 0, bar: 1, baz: 2}.include?('foo') # => false
   #     {foo: 0, bar: 1, baz: 2}.include?(0)     # => false
   #
-  # Enumerable#member? is an alias for Enumerable#include?.
-  #
   def include?: (Elem arg0) -> bool
 
   # <!--
@@ -874,8 +875,6 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #     "Memo: 3; element: 3"
   #     "Memo: 6; element: 4"
   #
-  # Enumerable#reduce is an alias for Enumerable#inject.
-  #
   def inject: (untyped init, Symbol method) -> untyped
             | (Symbol method) -> untyped
             | [A] (A initial) { (A, Elem) -> A } -> A
@@ -1446,8 +1445,8 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
 
   # <!--
   #   rdoc-file=enum.c
-  #   - to_h -> hash
-  #   - to_h {|element| ... }  -> hash
+  #   - to_h(*args) -> hash
+  #   - to_h(*args) {|element| ... }  -> hash
   # -->
   # When `self` consists of 2-element arrays, returns a hash each of whose entries
   # is the key-value pair formed from one of those arrays:
@@ -1570,8 +1569,6 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #     {foo: 0, bar: 1, baz: 2}.include?('foo') # => false
   #     {foo: 0, bar: 1, baz: 2}.include?(0)     # => false
   #
-  # Enumerable#member? is an alias for Enumerable#include?.
-  #
   def member?: (Elem arg0) -> bool
 
   # <!-- rdoc-file=enum.c -->
@@ -1717,20 +1714,16 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #     "Memo: 3; element: 3"
   #     "Memo: 6; element: 4"
   #
-  # Enumerable#reduce is an alias for Enumerable#inject.
-  #
   alias reduce inject
 
   # <!--
   #   rdoc-file=enum.c
-  #   - to_a -> array
+  #   - to_a(*args) -> array
   # -->
   # Returns an array containing the items in `self`:
   #
   #     (0..4).to_a # => [0, 1, 2, 3, 4]
   #
-  # Enumerable#entries is an alias for Enumerable#to_a.
-  #
   def to_a: () -> ::Array[Elem]
 
   # <!--
@@ -1774,8 +1767,8 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #     %w[a b c c b a a b c].uniq       # => ["a", "b", "c"]
   #     [0, 1, 2, 2, 1, 0, 0, 1, 2].uniq # => [0, 1, 2]
   #
-  # With a block, returns a new array containing only for which the block returns
-  # a unique value:
+  # With a block, returns a new array containing elements only for which the block
+  # returns a unique value:
   #
   #     a = [0, 1, 2, 3, 4, 5, 5, 4, 3, 2, 1]
   #     a.uniq {|i| i.even? ? i : 0 } # => [0, 2, 4]

data/core/enumerator.rbs

@@ -37,10 +37,10 @@
 # list's elements to strings containing the index and the element as a string
 # via:
 #
-#      puts %w[foo bar baz].map.with_index { |w, i| "#{i}:#{w}" }
-#      # => ["0:foo", "1:bar", "2:baz"]
+#     puts %w[foo bar baz].map.with_index { |w, i| "#{i}:#{w}" }
+#     # => ["0:foo", "1:bar", "2:baz"]
 #
-#     == External Iteration
+# ## External Iteration
 #
 # An Enumerator can also be used as an external iterator. For example,
 # Enumerator#next returns the next value of the iterator or raises StopIteration
@@ -52,42 +52,48 @@
 #     puts e.next   # => 3
 #     puts e.next   # raises StopIteration
 #
-# `next`, `next_values`, `peek` and `peek_values` are the only methods which use
-# external iteration (and Array#zip(Enumerable-not-Array) which uses `next`).
+# `next`, `next_values`, `peek`, and `peek_values` are the only methods which
+# use external iteration (and Array#zip(Enumerable-not-Array) which uses `next`
+# internally).
 #
 # These methods do not affect other internal enumeration methods, unless the
 # underlying iteration method itself has side-effect, e.g. IO#each_line.
 #
+# FrozenError will be raised if these methods are called against a frozen
+# enumerator. Since `rewind` and `feed` also change state for external
+# iteration, these methods may raise FrozenError too.
+#
 # External iteration differs **significantly** from internal iteration due to
 # using a Fiber:
-#     - The Fiber adds some overhead compared to internal enumeration.
-#     - The stacktrace will only include the stack from the Enumerator, not above.
-#     - Fiber-local variables are *not* inherited inside the Enumerator Fiber,
-#       which instead starts with no Fiber-local variables.
-#     - Fiber storage variables *are* inherited and are designed
-#       to handle Enumerator Fibers. Assigning to a Fiber storage variable
-#       only affects the current Fiber, so if you want to change state
-#       in the caller Fiber of the Enumerator Fiber, you need to use an
-#       extra indirection (e.g., use some object in the Fiber storage
-#       variable and mutate some ivar of it).
+# *   The Fiber adds some overhead compared to internal enumeration.
+# *   The stacktrace will only include the stack from the Enumerator, not above.
+# *   Fiber-local variables are **not** inherited inside the Enumerator Fiber,
+#     which instead starts with no Fiber-local variables.
+# *   Fiber storage variables **are** inherited and are designed to handle
+#     Enumerator Fibers. Assigning to a Fiber storage variable only affects the
+#     current Fiber, so if you want to change state in the caller Fiber of the
+#     Enumerator Fiber, you need to use an extra indirection (e.g., use some
+#     object in the Fiber storage variable and mutate some ivar of it).
+#
 #
 # Concretely:
-#      Thread.current[:fiber_local] = 1
-#      Fiber[:storage_var] = 1
-#      e = Enumerator.new do |y|
-#        p Thread.current[:fiber_local] # for external iteration: nil, for internal iteration: 1
-#        p Fiber[:storage_var] # => 1, inherited
-#        Fiber[:storage_var] += 1
-#        y << 42
-#      end
-#
-#      p e.next # => 42
-#      p Fiber[:storage_var] # => 1 (it ran in a different Fiber)
-#
-#      e.each { p _1 }
-#      p Fiber[:storage_var] # => 2 (it ran in the same Fiber/"stack" as the current Fiber)
-#
-#     == Convert External Iteration to Internal Iteration
+#
+#     Thread.current[:fiber_local] = 1
+#     Fiber[:storage_var] = 1
+#     e = Enumerator.new do |y|
+#       p Thread.current[:fiber_local] # for external iteration: nil, for internal iteration: 1
+#       p Fiber[:storage_var] # => 1, inherited
+#       Fiber[:storage_var] += 1
+#       y << 42
+#     end
+#
+#     p e.next # => 42
+#     p Fiber[:storage_var] # => 1 (it ran in a different Fiber)
+#
+#     e.each { p _1 }
+#     p Fiber[:storage_var] # => 2 (it ran in the same Fiber/"stack" as the current Fiber)
+#
+# ## Convert External Iteration to Internal Iteration
 #
 # You can use an external iterator to implement an internal iterator as follows:
 #

data/core/errors.rbs

@@ -188,6 +188,10 @@ end
 #
 #     LoadError: no such file to load -- this/file/does/not/exist
 #
+# <!-- rdoc-file=lib/bundled_gems.rb -->
+# for RubyGems without Bundler environment. If loading library is not part of
+# the default gems and the bundled gems, warn it.
+#
 class LoadError < ScriptError
   # <!-- rdoc-file=error.c -->
   # the path failed to load

data/core/false_class.rbs

@@ -8,32 +8,47 @@ class FalseClass
 
   # <!--
   #   rdoc-file=object.c
-  #   - false & obj   -> false
-  #   - nil & obj     -> false
+  #   - false & object -> false
+  #   - nil & object   -> false
   # -->
-  # And---Returns `false`. *obj* is always evaluated as it is the argument to a
-  # method call---there is no short-circuit evaluation in this case.
+  # Returns `false`:
+  #
+  #     false & true       # => false
+  #     false & Object.new # => false
+  #
+  # Argument `object` is evaluated:
+  #
+  #     false & raise # Raises RuntimeError.
   #
   def &: (untyped obj) -> false
 
   # <!--
   #   rdoc-file=object.c
-  #   - obj === other   -> true or false
+  #   - true === other -> true or false
+  #   - false === other -> true or false
+  #   - nil === other -> true or false
   # -->
-  # Case Equality -- For class Object, effectively the same as calling `#==`, but
-  # typically overridden by descendants to provide meaningful semantics in `case`
-  # statements.
+  # Returns `true` or `false`.
+  #
+  # Like Object#==, if `object` is an instance of Object (and not an instance of
+  # one of its many subclasses).
+  #
+  # This method is commonly overridden by those subclasses, to provide meaningful
+  # semantics in `case` statements.
   #
   def ===: (false) -> true
          | (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=object.c
-  #   - false ^ obj    -> true or false
-  #   - nil   ^ obj    -> true or false
+  #   - false ^ object -> true or false
+  #   - nil ^ object   -> true or false
   # -->
-  # Exclusive Or---If *obj* is `nil` or `false`, returns `false`; otherwise,
-  # returns `true`.
+  # Returns `false` if `object` is `nil` or `false`, `true` otherwise:
+  #
+  #     nil ^ nil        # => false
+  #     nil ^ false      # => false
+  #     nil ^ Object.new # => true
   #
   def ^: (false | nil) -> false
        | (untyped obj) -> bool
@@ -53,10 +68,14 @@ class FalseClass
 
   # <!--
   #   rdoc-file=object.c
-  #   - false | obj   ->   true or false
-  #   - nil   | obj   ->   true or false
+  #   - false | object -> true or false
+  #   - nil   | object -> true or false
   # -->
-  # Or---Returns `false` if *obj* is `nil` or `false`; `true` otherwise.
+  # Returns `false` if `object` is `nil` or `false`, `true` otherwise:
+  #
+  #     nil | nil        # => false
+  #     nil | false      # => false
+  #     nil | Object.new # => true
   #
   def |: (nil | false) -> false
        | (untyped obj) -> bool

data/core/fiber.rbs

@@ -369,6 +369,27 @@ class Fiber < Object
   #
   alias inspect to_s
 
+  # <!--
+  #   rdoc-file=cont.c
+  #   - fiber.kill -> nil
+  # -->
+  # Terminates the fiber by raising an uncatchable exception. It only terminates
+  # the given fiber and no other fiber, returning `nil` to another fiber if that
+  # fiber was calling #resume or #transfer.
+  #
+  # `Fiber#kill` only interrupts another fiber when it is in Fiber.yield. If
+  # called on the current fiber then it raises that exception at the `Fiber#kill`
+  # call site.
+  #
+  # If the fiber has not been started, transition directly to the terminated
+  # state.
+  #
+  # If the fiber is already terminated, does nothing.
+  #
+  # Raises FiberError if called on a fiber belonging to another thread.
+  #
+  def kill: () -> nil
+
   # <!--
   #   rdoc-file=cont.c
   #   - fiber.raise                                 -> obj
@@ -389,6 +410,8 @@ class Fiber < Object
   # parameter is an array of callback information. Exceptions are caught by the
   # `rescue` clause of `begin...end` blocks.
   #
+  # Raises `FiberError` if called on a Fiber belonging to another `Thread`.
+  #
   def raise: (?string msg) -> untyped
            | (_Exception, ?string msg, ?Array[string] backtrace) -> untyped