rbs 4.0.0.dev.4 → 4.0.0

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 <code>ruby -v</code> 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/ruby_vm.rbs

@@ -41,8 +41,8 @@ RubyVM::OPTS: Array[String]
 # you want to learn how YARV works, but it also lets you control various
 # settings for the Ruby iseq compiler.
 #
-# You can find the source for the VM instructions in `insns.def` in the Ruby
-# source.
+# You can find the source for the VM instructions in <code>insns.def</code> in
+# the Ruby source.
 #
 # The instruction sequence results will almost certainly change as Ruby changes,
 # so example output in this documentation may be different from what you see.
@@ -183,8 +183,8 @@ class RubyVM::InstructionSequence < Object
   # -->
   # Returns the label of this instruction sequence.
   #
-  # `<main>` if it's at the top level, `<compiled>` if it was evaluated from a
-  # string.
+  # <code><main></code> if it's at the top level, <code><compiled></code> if it
+  # was evaluated from a string.
   #
   # For example, using irb:
   #
@@ -212,7 +212,7 @@ class RubyVM::InstructionSequence < Object
   # -->
   # Returns the path of this instruction sequence.
   #
-  # `<compiled>` if the iseq was evaluated from a string.
+  # <code><compiled></code> if the iseq was evaluated from a string.
   #
   # For example, using irb:
   #
@@ -254,8 +254,8 @@ class RubyVM::InstructionSequence < Object
   # the following data:
   #
   # magic
-  # :   A string identifying the data format. **Always
-  #     `YARVInstructionSequence/SimpleDataFormat`.**
+  # :   A string identifying the data format. <strong>Always
+  #     <code>YARVInstructionSequence/SimpleDataFormat</code>.</strong>
   #
   #
   # major_version
@@ -273,14 +273,14 @@ class RubyVM::InstructionSequence < Object
   # misc
   # :   A hash containing:
   #
-  #     `:arg_size`
+  #     <code>:arg_size</code>
   # :       the total number of arguments taken by the method or the block (0 if
   #         *iseq* doesn't represent a method or block)
   #
-  #     `:local_size`
+  #     <code>:local_size</code>
   # :       the number of local variables + 1
   #
-  #     `:stack_max`
+  #     <code>:stack_max</code>
   # :       used in calculating the stack depth at which a SystemStackError is
   #         thrown.
   #
@@ -290,15 +290,15 @@ class RubyVM::InstructionSequence < Object
   # :   The name of the context (block, method, class, module, etc.) that this
   #     instruction sequence belongs to.
   #
-  #     `<main>` if it's at the top level, `<compiled>` if it was evaluated from a
-  #     string.
+  #     <code><main></code> if it's at the top level, <code><compiled></code> if
+  #     it was evaluated from a string.
   #
   #
   # #path
   # :   The relative path to the Ruby file where the instruction sequence was
   #     loaded from.
   #
-  #     `<compiled>` if the iseq was evaluated from a string.
+  #     <code><compiled></code> if the iseq was evaluated from a string.
   #
   #
   # #absolute_path
@@ -316,8 +316,9 @@ class RubyVM::InstructionSequence < Object
   # type
   # :   The type of the instruction sequence.
   #
-  #     Valid values are `:top`, `:method`, `:block`, `:class`, `:rescue`,
-  #     `:ensure`, `:eval`, `:main`, and `plain`.
+  #     Valid values are <code>:top</code>, <code>:method</code>,
+  #     <code>:block</code>, <code>:class</code>, <code>:rescue</code>,
+  #     <code>:ensure</code>, <code>:eval</code>, <code>:main</code>, and `plain`.
   #
   #
   # locals
@@ -328,7 +329,7 @@ class RubyVM::InstructionSequence < Object
   # params
   # :   An Hash object containing parameter information.
   #
-  #     More info about these values can be found in `vm_core.h`.
+  #     More info about these values can be found in <code>vm_core.h</code>.
   #
   #
   # catch_table
@@ -400,15 +401,16 @@ module RubyVM::AbstractSyntaxTree
   #     RubyVM::AbstractSyntaxTree.parse("x = 1 + 2")
   #     # => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:0-1:9>
   #
-  # If `keep_script_lines: true` option is provided, the text of the parsed source
-  # is associated with nodes and is available via Node#script_lines.
+  # If <code>keep_script_lines: true</code> option is provided, the text of the
+  # parsed source is associated with nodes and is available via Node#script_lines.
   #
-  # If `keep_tokens: true` option is provided, Node#tokens are populated.
+  # If <code>keep_tokens: true</code> option is provided, Node#tokens are
+  # populated.
   #
   # SyntaxError is raised if the given *string* is invalid syntax. To overwrite
-  # this behavior, `error_tolerant: true` can be provided. In this case, the
-  # parser will produce a tree where expressions with syntax errors would be
-  # represented by Node with `type=:ERROR`.
+  # this behavior, <code>error_tolerant: true</code> can be provided. In this
+  # case, the parser will produce a tree where expressions with syntax errors
+  # would be represented by Node with <code>type=:ERROR</code>.
   #
   #     root = RubyVM::AbstractSyntaxTree.parse("x = 1; p(x; y=2")
   #     # <internal:ast>:33:in `parse': syntax error, unexpected ';', expecting ')' (SyntaxError)
@@ -443,7 +445,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
@@ -661,7 +663,7 @@ module RubyVM::YJIT
   # -->
   # Marshal dumps exit locations to the given filename.
   # Usage:
-  # If `--yjit-exit-locations` is passed, a file named
+  # If <code>--yjit-exit-locations</code> is passed, a file named
   # "yjit_exit_locations.dump" will automatically be generated.
   # If you want to collect traces manually, call `dump_exit_locations`
   # directly.
@@ -683,19 +685,21 @@ 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.
-  #     *   `:quiet`: Enable stats. Do not print stats at exit.
+  #     *   <code>:quiet</code>: Enable stats. Do not print stats at exit.
   # *   `log`:
   #     *   `false`: Don't enable the log.
   #     *   `true`: Enable the log. Print log at exit.
-  #     *   `:quiet`: Enable the log. Do not print log at exit.
+  #     *   <code>:quiet</code>: Enable the log. Do not print log at exit.
   #
   def self.enable: (?stats: false | true | :quiet) -> void
 
@@ -727,7 +731,7 @@ module RubyVM::YJIT
   #   rdoc-file=yjit.rb
   #   - reset_stats!()
   # -->
-  # Discard statistics collected for `--yjit-stats`.
+  # Discard statistics collected for <code>--yjit-stats</code>.
   #
   def self.reset_stats!: () -> void
 
@@ -735,8 +739,8 @@ module RubyVM::YJIT
   #   rdoc-file=yjit.rb
   #   - runtime_stats(key = nil)
   # -->
-  # Return a hash for statistics generated for the `--yjit-stats` command line
-  # option.
+  # Return a hash for statistics generated for the <code>--yjit-stats</code>
+  # command line option.
   # Return `nil` when option is not passed or unavailable.
   # If a symbol argument is provided, return only the value for the named stat.
   # If any other type is provided, raises TypeError.
@@ -747,7 +751,7 @@ module RubyVM::YJIT
   #   rdoc-file=yjit.rb
   #   - stats_enabled?()
   # -->
-  # Check if `--yjit-stats` is used.
+  # Check if <code>--yjit-stats</code> is used.
   #
   def self.stats_enabled?: () -> bool
 
@@ -756,7 +760,7 @@ module RubyVM::YJIT
   #   - stats_string()
   # -->
   # Format and print out counters as a String. This returns a non-empty
-  # content only when `--yjit-stats` is enabled.
+  # content only when <code>--yjit-stats</code> is enabled.
   #
   def self.stats_string: () -> String
 end

data/core/rubygems/config_file.rbs

@@ -10,20 +10,20 @@
 #     install: --no-rdoc --no-ri
 #     update: --no-rdoc --no-ri
 #
-# You can use `gem:` to set default arguments for all commands.
+# You can use <code>gem:</code> to set default arguments for all commands.
 #
 # RubyGems options use symbol keys.  Valid options are:
 #
-# `:backtrace`
+# <code>:backtrace</code>
 # :   See #backtrace
 #
-# `:sources`
+# <code>:sources</code>
 # :   Sets Gem::sources
 #
-# `:verbose`
+# <code>:verbose</code>
 # :   See #verbose
 #
-# `:concurrent_downloads`
+# <code>:concurrent_downloads</code>
 # :   See #concurrent_downloads
 #
 #

data/core/rubygems/errors.rbs

@@ -4,7 +4,7 @@
 #
 # For user documentation, see:
 #
-# *   `gem help` and `gem help [command]`
+# *   `gem help` and <code>gem help [command]</code>
 # *   [RubyGems User Guide](https://guides.rubygems.org/)
 # *   [Frequently Asked Questions](https://guides.rubygems.org/faqs)
 #
@@ -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/requirement.rbs

@@ -2,7 +2,7 @@
 module Gem
   # <!-- rdoc-file=lib/rubygems/requirement.rb -->
   # A Requirement is a set of one or more version restrictions. It supports a few
-  # (`=, !=, >, <, >=, <=, ~>`) different restriction operators.
+  # (<code>=, !=, >, <, >=, <=, ~></code>) different restriction operators.
   #
   # See Gem::Version for a description on how versions and requirements work
   # together in RubyGems.
@@ -60,11 +60,11 @@ module Gem
     #   rdoc-file=lib/rubygems/requirement.rb
     #   - parse(obj)
     # -->
-    # Parse `obj`, returning an `[op, version]` pair. `obj` can be a String or a
-    # Gem::Version.
+    # Parse `obj`, returning an <code>[op, version]</code> pair. `obj` can be a
+    # String or a Gem::Version.
     #
     # If `obj` is a String, it can be either a full requirement specification, like
-    # `">= 1.2"`, or a simple version number, like `"1.2"`.
+    # <code>">= 1.2"</code>, or a simple version number, like <code>"1.2"</code>.
     #
     #     parse("> 1.0")                 # => [">", Gem::Version.new("1.0")]
     #     parse("1.0")                   # => ["=", Gem::Version.new("1.0")]
@@ -78,7 +78,7 @@ module Gem
     # -->
     # Constructs a requirement from `requirements`. Requirements can be Strings,
     # Gem::Versions, or Arrays of those. `nil` and duplicate requirements are
-    # ignored. An empty set of `requirements` is the same as `">= 0"`.
+    # ignored. An empty set of `requirements` is the same as <code>">= 0"</code>.
     #
     def initialize: (*String | Gem::Version requirements) -> void
 

data/core/rubygems/rubygems.rbs

@@ -4,7 +4,7 @@
 #
 # For user documentation, see:
 #
-# *   `gem help` and `gem help [command]`
+# *   `gem help` and <code>gem help [command]</code>
 # *   [RubyGems User Guide](https://guides.rubygems.org/)
 # *   [Frequently Asked Questions](https://guides.rubygems.org/faqs)
 #
@@ -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]
@@ -219,7 +152,8 @@ module Gem
   #   - activated_gem_paths()
   # -->
   # The number of paths in the +$LOAD_PATH+ from activated gems. Used to
-  # prioritize `-I` and `ENV['RUBYLIB']` entries during `require`.
+  # prioritize <code>-I</code> and <code>ENV['RUBYLIB']</code> entries during
+  # `require`.
   #
   def self.activated_gem_paths: () -> Integer
 
@@ -251,7 +185,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 +443,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 +460,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 +485,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
@@ -566,7 +500,8 @@ module Gem
   #   rdoc-file=lib/rubygems.rb
   #   - host()
   # -->
-  # Get the default RubyGems API host. This is normally `https://rubygems.org`.
+  # Get the default RubyGems API host. This is normally
+  # <code>https://rubygems.org</code>.
   #
   def self.host: () -> String
 
@@ -804,7 +739,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 +944,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 +1088,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?

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?