rbs 4.0.0.dev.5 → 4.0.1.dev.1

data/core/ruby.rbs

@@ -11,7 +11,7 @@ module Ruby
   COPYRIGHT: ::String
 
   # <!-- rdoc-file=version.c -->
-  # The full ruby version string, like `ruby -v` prints
+  # The full ruby version string, like <code>ruby -v</code> prints
   #
   DESCRIPTION: ::String
 

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)
@@ -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.
@@ -693,11 +695,11 @@ module RubyVM::YJIT
   # *   `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
 
@@ -729,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
 
@@ -737,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.
@@ -749,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
 
@@ -758,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)
 #

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)
 #
@@ -152,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
 
@@ -499,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
 

data/core/set.rbs

@@ -22,10 +22,11 @@
 #
 # ## Comparison
 #
-# The comparison operators `<`, `>`, `<=`, and `>=` are implemented as shorthand
-# for the {proper_,}{subset?,superset?} methods.  The `<=>` operator reflects
-# this order, or returns `nil` for sets that both have distinct elements (`{x,
-# y}` vs. `{x, z}` for example).
+# The comparison operators <code><</code>, <code>></code>, <code><=</code>, and
+# <code>>=</code> are implemented as shorthand for the
+# {proper_,}{subset?,superset?} methods.  The <code><=></code> operator reflects
+# this order, or returns `nil` for sets that both have distinct elements
+# (<code>{x, y}</code> vs. <code>{x, z}</code> for example).
 #
 # ## Example
 #
@@ -48,9 +49,9 @@
 # core methods were adjusted.
 #
 # To keep backward compatibility, when a class is inherited from Set, additional
-# module `Set::SubclassCompatible` is included, which makes the inherited class
-# behavior, as well as internal method names, closer to what it was before Ruby
-# 4.0.
+# module <code>Set::SubclassCompatible</code> is included, which makes the
+# inherited class behavior, as well as internal method names, closer to what it
+# was before Ruby 4.0.
 #
 # It can be easily seen, for example, in the #inspect method behavior:
 #
@@ -63,7 +64,7 @@
 #     # prints "#<MySet: {1, 2, 3}>", like it was in Ruby 3.4
 #
 # For new code, if backward compatibility is not necessary, it is recommended to
-# instead inherit from `Set::CoreSet`, which avoids including the
+# instead inherit from <code>Set::CoreSet</code>, which avoids including the
 # "compatibility" layer:
 #
 #     class MyCoreSet < Set::CoreSet
@@ -340,8 +341,8 @@ class Set[unchecked out A]
   #     Set[1, 2, 3].include? 2   #=> true
   #     Set[1, 2, 3].include? 4   #=> false
   #
-  # Note that `include?` and `member?` do not test member equality using `==` as
-  # do other Enumerables.
+  # Note that <code>include?</code> and <code>member?</code> do not test member
+  # equality using <code>==</code> as do other Enumerables.
   #
   # This is aliased to #===, so it is usable in `case` expressions:
   #
@@ -355,7 +356,7 @@ class Set[unchecked out A]
   #
   # See also Enumerable#include?
   #
-  def include?: (A) -> bool
+  def include?: (Hash::_Key) -> bool
 
   # <!-- rdoc-file=set.c -->
   # Returns true if the set contains the given object:
@@ -363,8 +364,8 @@ class Set[unchecked out A]
   #     Set[1, 2, 3].include? 2   #=> true
   #     Set[1, 2, 3].include? 4   #=> false
   #
-  # Note that `include?` and `member?` do not test member equality using `==` as
-  # do other Enumerables.
+  # Note that <code>include?</code> and <code>member?</code> do not test member
+  # equality using <code>==</code> as do other Enumerables.
   #
   # This is aliased to #===, so it is usable in `case` expressions:
   #
@@ -385,8 +386,8 @@ class Set[unchecked out A]
   #   - set ^ enum -> new_set
   # -->
   # Returns a new set containing elements exclusive between the set and the given
-  # enumerable object.  `(set ^ enum)` is equivalent to `((set | enum) - (set &
-  # enum))`.
+  # enumerable object.  <code>(set ^ enum)</code> is equivalent to <code>((set |
+  # enum) - (set & enum))</code>.
   #
   #     Set[1, 2] ^ Set[2, 3]                   #=> Set[3, 1]
   #     Set[1, 'b', 'c'] ^ ['b', 'd']           #=> Set["d", 1, "c"]
@@ -500,7 +501,7 @@ class Set[unchecked out A]
   #   - disjoint?(set) -> true or false
   # -->
   # Returns true if the set and the given enumerable have no element in common.
-  # This method is the opposite of `intersect?`.
+  # This method is the opposite of <code>intersect?</code>.
   #
   #     Set[1, 2, 3].disjoint? Set[3, 4]   #=> false
   #     Set[1, 2, 3].disjoint? Set[4, 5]   #=> true

data/core/signal.rbs

@@ -26,7 +26,7 @@
 #     # ...
 #     Process.kill("TERM", pid)
 #
-# *produces:*
+# <em>produces:</em>
 #     Debug now: true
 #     Debug now: false
 #     Terminating...
@@ -57,7 +57,7 @@ module Signal
   #     Signal.trap("INT") { |signo| puts Signal.signame(signo) }
   #     Process.kill("INT", 0)
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     INT
   #