rbs 3.9.5 → 3.10.0.pre.1

data/core/range.rbs

@@ -86,14 +86,14 @@
 #     end
 #     a # => [2, 4, 6, 8, 10]
 #
-# A range can be both beginless and endless.  For literal beginless, endless
+# A range can be both beginless and endless. For literal beginless, endless
 # ranges, at least the beginning or end of the range must be given as an
 # explicit nil value. It is recommended to use an explicit nil beginning and
-# implicit nil end, since that is what Ruby uses for Range#inspect:
+# end, since that is what Ruby uses for Range#inspect:
 #
-#     (nil..)    # => (nil..)
-#     (..nil)    # => (nil..)
-#     (nil..nil) # => (nil..)
+#     (nil..)    # => (nil..nil)
+#     (..nil)    # => (nil..nil)
+#     (nil..nil) # => (nil..nil)
 #
 # ## Ranges and Other Classes
 #
@@ -936,8 +936,7 @@ class Range[out Elem] < Object
   #
   # Related: Range#count.
   #
-  def size: () -> Integer?
-          | () -> Float?
+  def size: () -> (Integer | Float | nil)
 
   # <!--
   #   rdoc-file=range.c

data/core/rbs/unnamed/argf.rbs

@@ -93,7 +93,7 @@ module RBS
     # *   File `t.rb`:
     #
     #         p "ARGV: #{ARGV}"
-    #         p "Line: #{ARGF.read}" # Read everything from all specified streams.
+    #         p "Read: #{ARGF.read}" # Read everything from all specified streams.
     #
     # *   Command and output:
     #

data/core/rbs/unnamed/env_class.rbs

@@ -140,7 +140,7 @@ module RBS
     #
     # *   ::assoc: Returns a 2-element array containing the name and value of the
     #     named environment variable if it exists:
-    # *   ::clone: Returns `ENV` (and issues a warning).
+    # *   ::clone: Raises an exception.
     # *   ::except: Returns a hash of all name/value pairs except those given.
     # *   ::fetch: Returns the value for the given name.
     # *   ::inspect: Returns the contents of `ENV` as a string.

data/core/rbs/unnamed/random.rbs

@@ -31,9 +31,11 @@ module RBS
       #     prng.rand(100)       # => 42
       #
       # When `max` is a Float, `rand` returns a random floating point number between
-      # 0.0 and `max`, including 0.0 and excluding `max`.
+      # 0.0 and `max`, including 0.0 and excluding `max`. Note that it behaves
+      # differently from Kernel.rand.
       #
-      #     prng.rand(1.5)       # => 1.4600282860034115
+      #     prng.rand(1.5)  # => 1.4600282860034115
+      #     rand(1.5)       # => 0
       #
       # When `range` is a Range, `rand` returns a random number where
       # `range.member?(number) == true`.

data/core/regexp.rbs

@@ -126,6 +126,9 @@
 #     `nil`. Note that `$0` is quite different; it returns the name of the
 #     currently executing program.
 #
+# These variables, except for `$~`, are shorthands for methods of `$~`.  See
+# MatchData@Global+variables+equivalence.
+#
 # Examples:
 #
 #     # Matched string, but no matched groups.
@@ -435,6 +438,9 @@
 #     /(?<=<b>)\w+(?=<\/b>)/.match("Fortune favors the <b>bold</b>.")
 #     # => #<MatchData "bold">
 #
+# The pattern in lookbehind must be fixed-width. But top-level alternatives can
+# be of various lengths. ex. (?<=a|bc) is OK. (?<=aaa(?:b|cd)) is not allowed.
+#
 # #### Match-Reset Anchor
 #
 # *   `\K`: Match reset: the matched content preceding `\K` in the regexp is
@@ -495,7 +501,7 @@
 #         /\w*/.match('x')
 #         # => #<MatchData "x">
 #         /\w*/.match('xyz')
-#         # => #<MatchData "yz">
+#         # => #<MatchData "xyz">
 #
 # *   `+` - Matches one or more times:
 #
@@ -708,7 +714,7 @@
 #
 # 1.  The leading subexpression `"` in the pattern matches the first character
 #     `"` in the target string.
-# 2.  The next subexpression `.*` matches the next substring `Quote“` (including
+# 2.  The next subexpression `.*` matches the next substring `Quote"` (including
 #     the trailing double-quote).
 # 3.  Now there is nothing left in the target string to match the trailing
 #     subexpression `"` in the pattern; this would cause the overall match to
@@ -1248,7 +1254,7 @@
 #
 # Regexp matching can apply an optimization to prevent ReDoS attacks. When the
 # optimization is applied, matching time increases linearly (not polynomially or
-# exponentially) in relation to the input size, and a ReDoS attach is not
+# exponentially) in relation to the input size, and a ReDoS attack is not
 # possible.
 #
 # This optimization is applied if the pattern meets these criteria:
@@ -1272,21 +1278,14 @@
 #
 # ## References
 #
-# Read (online PDF books):
+# Read:
 #
-# *   [Mastering Regular
-#     Expressions](https://ia902508.us.archive.org/10/items/allitebooks-02/Maste
-#     ring%20Regular%20Expressions%2C%203rd%20Edition.pdf) by Jeffrey E.F.
-#     Friedl.
-# *   [Regular Expressions
-#     Cookbook](https://doc.lagout.org/programmation/Regular%20Expressions/Regul
-#     ar%20Expressions%20Cookbook_%20Detailed%20Solutions%20in%20Eight%20Program
-#     ming%20Languages%20%282nd%20ed.%29%20%5BGoyvaerts%20%26%20Levithan%202012-
-#     09-06%5D.pdf) by Jan Goyvaerts & Steven Levithan.
+# *   *Mastering Regular Expressions* by Jeffrey E.F. Friedl.
+# *   *Regular Expressions Cookbook* by Jan Goyvaerts & Steven Levithan.
 #
-# Explore, test (interactive online editor):
+# Explore, test:
 #
-# *   [Rubular](https://rubular.com/).
+# *   [Rubular](https://rubular.com/): interactive online editor.
 #
 class Regexp
   # Represents an object's ability to be converted to a `Regexp`.
@@ -1297,6 +1296,9 @@ class Regexp
     def to_regexp: () -> Regexp
   end
 
+  # <!-- rdoc-file=re.c -->
+  # Raised when regexp matching timed out.
+  #
   class TimeoutError < RegexpError
   end
 
@@ -1658,9 +1660,12 @@ class Regexp
 
   # <!--
   #   rdoc-file=re.c
-  #   - obj.encoding   -> encoding
+  #   - encoding -> encoding
   # -->
-  # Returns the Encoding object that represents the encoding of obj.
+  # Returns an Encoding object that represents the encoding of `self`; see
+  # [Encodings](rdoc-ref:encodings.rdoc).
+  #
+  # Related: see [Querying](rdoc-ref:String@Querying).
   #
   def encoding: () -> Encoding
 

data/core/ruby_vm.rbs

@@ -443,7 +443,7 @@ module RubyVM::AbstractSyntaxTree
   #
   # See ::parse for explanation of keyword argument meaning and usage.
   #
-  def self.parse_file: (String | ::_ToPath string, ?keep_script_lines: bool, ?error_tolerant: bool, ?keep_tokens: bool) -> Node
+  def self.parse_file: (path string, ?keep_script_lines: bool, ?error_tolerant: bool, ?keep_tokens: bool) -> Node
 
   # <!--
   #   rdoc-file=ast.rb
@@ -683,11 +683,13 @@ module RubyVM::YJIT
 
   # <!--
   #   rdoc-file=yjit.rb
-  #   - enable(stats: false, log: false)
+  #   - enable(stats: false, log: false, mem_size: nil, call_threshold: nil)
   # -->
   # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats
-  # or not. `compilation_log` decides
-  # whether to enable YJIT compilation logging or not.
+  # or not. `log` decides
+  # whether to enable YJIT compilation logging or not. Optional `mem_size` and
+  # `call_threshold` can be
+  # provided to override default configuration.
   # *   `stats`:
   #     *   `false`: Don't enable stats.
   #     *   `true`: Enable stats. Print stats at exit.

data/core/rubygems/errors.rbs

@@ -17,7 +17,7 @@
 # Further RubyGems documentation can be found at:
 #
 # *   [RubyGems Guides](https://guides.rubygems.org)
-# *   [RubyGems API](https://www.rubydoc.info/github/rubygems/rubygems) (also
+# *   [RubyGems API](https://www.rubydoc.info/github/ruby/rubygems) (also
 #     available from `gem server`)
 #
 # ## RubyGems Plugins
@@ -48,7 +48,7 @@
 # ## Bugs
 #
 # You can submit bugs to the [RubyGems bug
-# tracker](https://github.com/rubygems/rubygems/issues) on GitHub
+# tracker](https://github.com/ruby/rubygems/issues) on GitHub
 #
 # ## Credits
 #
@@ -83,80 +83,13 @@
 #
 # ## License
 #
-# See
-# [LICENSE.txt](https://github.com/rubygems/rubygems/blob/master/LICENSE.txt)
+# See [LICENSE.txt](https://github.com/ruby/rubygems/blob/master/LICENSE.txt)
 # for permissions.
 #
 # Thanks!
 #
 # -The RubyGems Team
 #
-# <!-- rdoc-file=lib/rubygems/deprecate.rb -->
-# Provides 3 methods for declaring when something is going away.
-#
-# +deprecate(name, repl, year, month)+:
-#     Indicate something may be removed on/after a certain date.
-#
-# +rubygems_deprecate(name, replacement=:none)+:
-#     Indicate something will be removed in the next major RubyGems version,
-#     and (optionally) a replacement for it.
-#
-# `rubygems_deprecate_command`:
-#     Indicate a RubyGems command (in +lib/rubygems/commands/*.rb+) will be
-#     removed in the next RubyGems version.
-#
-# Also provides `skip_during` for temporarily turning off deprecation warnings.
-# This is intended to be used in the test suite, so deprecation warnings don't
-# cause test failures if you need to make sure stderr is otherwise empty.
-#
-# Example usage of `deprecate` and `rubygems_deprecate`:
-#
-#     class Legacy
-#       def self.some_class_method
-#         # ...
-#       end
-#
-#       def some_instance_method
-#         # ...
-#       end
-#
-#       def some_old_method
-#         # ...
-#       end
-#
-#       extend Gem::Deprecate
-#       deprecate :some_instance_method, "X.z", 2011, 4
-#       rubygems_deprecate :some_old_method, "Modern#some_new_method"
-#
-#       class << self
-#         extend Gem::Deprecate
-#         deprecate :some_class_method, :none, 2011, 4
-#       end
-#     end
-#
-# Example usage of `rubygems_deprecate_command`:
-#
-#     class Gem::Commands::QueryCommand < Gem::Command
-#       extend Gem::Deprecate
-#       rubygems_deprecate_command
-#
-#       # ...
-#     end
-#
-# Example usage of `skip_during`:
-#
-#     class TestSomething < Gem::Testcase
-#       def test_some_thing_with_deprecations
-#         Gem::Deprecate.skip_during do
-#           actual_stdout, actual_stderr = capture_output do
-#             Gem.something_deprecated
-#           end
-#           assert_empty actual_stdout
-#           assert_equal(expected, actual_stderr)
-#         end
-#       end
-#     end
-#
 module Gem
   # <!-- rdoc-file=lib/rubygems/errors.rb -->
   # Raised when RubyGems is unable to load or activate a gem.  Contains the name

data/core/rubygems/rubygems.rbs

@@ -17,7 +17,7 @@
 # Further RubyGems documentation can be found at:
 #
 # *   [RubyGems Guides](https://guides.rubygems.org)
-# *   [RubyGems API](https://www.rubydoc.info/github/rubygems/rubygems) (also
+# *   [RubyGems API](https://www.rubydoc.info/github/ruby/rubygems) (also
 #     available from `gem server`)
 #
 # ## RubyGems Plugins
@@ -48,7 +48,7 @@
 # ## Bugs
 #
 # You can submit bugs to the [RubyGems bug
-# tracker](https://github.com/rubygems/rubygems/issues) on GitHub
+# tracker](https://github.com/ruby/rubygems/issues) on GitHub
 #
 # ## Credits
 #
@@ -83,80 +83,13 @@
 #
 # ## License
 #
-# See
-# [LICENSE.txt](https://github.com/rubygems/rubygems/blob/master/LICENSE.txt)
+# See [LICENSE.txt](https://github.com/ruby/rubygems/blob/master/LICENSE.txt)
 # for permissions.
 #
 # Thanks!
 #
 # -The RubyGems Team
 #
-# <!-- rdoc-file=lib/rubygems/deprecate.rb -->
-# Provides 3 methods for declaring when something is going away.
-#
-# +deprecate(name, repl, year, month)+:
-#     Indicate something may be removed on/after a certain date.
-#
-# +rubygems_deprecate(name, replacement=:none)+:
-#     Indicate something will be removed in the next major RubyGems version,
-#     and (optionally) a replacement for it.
-#
-# `rubygems_deprecate_command`:
-#     Indicate a RubyGems command (in +lib/rubygems/commands/*.rb+) will be
-#     removed in the next RubyGems version.
-#
-# Also provides `skip_during` for temporarily turning off deprecation warnings.
-# This is intended to be used in the test suite, so deprecation warnings don't
-# cause test failures if you need to make sure stderr is otherwise empty.
-#
-# Example usage of `deprecate` and `rubygems_deprecate`:
-#
-#     class Legacy
-#       def self.some_class_method
-#         # ...
-#       end
-#
-#       def some_instance_method
-#         # ...
-#       end
-#
-#       def some_old_method
-#         # ...
-#       end
-#
-#       extend Gem::Deprecate
-#       deprecate :some_instance_method, "X.z", 2011, 4
-#       rubygems_deprecate :some_old_method, "Modern#some_new_method"
-#
-#       class << self
-#         extend Gem::Deprecate
-#         deprecate :some_class_method, :none, 2011, 4
-#       end
-#     end
-#
-# Example usage of `rubygems_deprecate_command`:
-#
-#     class Gem::Commands::QueryCommand < Gem::Command
-#       extend Gem::Deprecate
-#       rubygems_deprecate_command
-#
-#       # ...
-#     end
-#
-# Example usage of `skip_during`:
-#
-#     class TestSomething < Gem::Testcase
-#       def test_some_thing_with_deprecations
-#         Gem::Deprecate.skip_during do
-#           actual_stdout, actual_stderr = capture_output do
-#             Gem.something_deprecated
-#           end
-#           assert_empty actual_stdout
-#           assert_equal(expected, actual_stderr)
-#         end
-#       end
-#     end
-#
 module Gem
   interface _HashLike[K, V]
     def each_pair: () { ([ K, V ]) -> untyped } -> self
@@ -204,7 +137,7 @@ module Gem
 
   VERSION: String
 
-  # <!-- rdoc-file=lib/rubygems.rb -->
+  # <!-- rdoc-file=lib/rubygems/win_platform.rb -->
   # An Array of Regexps that match windows Ruby platforms.
   #
   WIN_PATTERNS: Array[Regexp]
@@ -251,7 +184,7 @@ module Gem
 
   # <!--
   #   rdoc-file=lib/rubygems.rb
-  #   - bindir(install_dir=Gem.dir)
+  #   - bindir(install_dir = Gem.dir)
   # -->
   # The path where gem executables are to be installed.
   #
@@ -509,7 +442,7 @@ module Gem
 
   # <!--
   #   rdoc-file=lib/rubygems.rb
-  #   - find_files(glob, check_load_path=true)
+  #   - find_files(glob, check_load_path = true)
   # -->
   # Returns a list of paths matching `glob` that can be used by a gem to pick up
   # features from other gems.  For example:
@@ -526,7 +459,7 @@ module Gem
 
   # <!--
   #   rdoc-file=lib/rubygems.rb
-  #   - find_latest_files(glob, check_load_path=true)
+  #   - find_latest_files(glob, check_load_path = true)
   # -->
   # Returns a list of paths matching `glob` from the latest gems that can be used
   # by a gem to pick up features from other gems.  For example:
@@ -551,7 +484,7 @@ module Gem
 
   # <!--
   #   rdoc-file=lib/rubygems.rb
-  #   - finish_resolve(request_set=Gem::RequestSet.new)
+  #   - finish_resolve(request_set = Gem::RequestSet.new)
   # -->
   #
   def self.finish_resolve: (?RequestSet request_set) -> void
@@ -804,7 +737,7 @@ module Gem
 
   # <!--
   #   rdoc-file=lib/rubygems.rb
-  #   - plugindir(install_dir=Gem.dir)
+  #   - plugindir(install_dir = Gem.dir)
   # -->
   # The path were rubygems plugins are to be installed.
   #
@@ -1009,8 +942,7 @@ module Gem
   #   - source_date_epoch_string()
   # -->
   # If the SOURCE_DATE_EPOCH environment variable is set, returns it's value.
-  # Otherwise, returns the time that `Gem.source_date_epoch_string` was first
-  # called in the same format as SOURCE_DATE_EPOCH.
+  # Otherwise, returns DEFAULT_SOURCE_DATE_EPOCH as a string.
   #
   # NOTE(@duckinator): The implementation is a tad weird because we want to:
   #     1. Make builds reproducible by default, by having this function always
@@ -1154,7 +1086,7 @@ module Gem
   def self.user_home: () -> String
 
   # <!--
-  #   rdoc-file=lib/rubygems.rb
+  #   rdoc-file=lib/rubygems/win_platform.rb
   #   - win_platform?()
   # -->
   # Is this a windows platform?