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

data/core/time.rbs

@@ -76,9 +76,9 @@
 # integer. However `localtime` on some platforms doesn't supports negative
 # `time_t` (before 1970).
 #
-# `struct tm` has *tm_year* member to represent years. (`tm_year = 0` means the
-# year 1900.) It is defined as `int` in the C standard. *tm_year* can represent
-# years between -2147481748 to 2147485547 if `int` is 32 bit.
+# `struct tm` has *tm_year* member to represent years. (<code>tm_year = 0</code>
+# means the year 1900.) It is defined as `int` in the C standard. *tm_year* can
+# represent years between -2147481748 to 2147485547 if `int` is 32 bit.
 #
 # Ruby supports leap seconds as far as if the C function `localtime` and
 # `gmtime` supports it. They use the tz database in most Unix systems. The tz
@@ -259,9 +259,9 @@
 #
 # Certain `Time` methods accept arguments that specify timezones:
 #
-# *   Time.at: keyword argument `in:`.
-# *   Time.new: positional argument `zone` or keyword argument `in:`.
-# *   Time.now: keyword argument `in:`.
+# *   Time.at: keyword argument <code>in:</code>.
+# *   Time.new: positional argument `zone` or keyword argument <code>in:</code>.
+# *   Time.now: keyword argument <code>in:</code>.
 # *   Time#getlocal: positional argument `zone`.
 # *   Time#localtime: positional argument `zone`.
 #
@@ -276,11 +276,11 @@
 #
 # ### Hours/Minutes Offsets
 #
-# The zone value may be a string offset from UTC in the form `'+HH:MM'` or
-# `'-HH:MM'`, where:
+# The zone value may be a string offset from UTC in the form
+# <code>'+HH:MM'</code> or <code>'-HH:MM'</code>, where:
 #
-# *   `HH` is the 2-digit hour in the range `0..23`.
-# *   `MM` is the 2-digit minute in the range `0..59`.
+# *   `HH` is the 2-digit hour in the range <code>0..23</code>.
+# *   `MM` is the 2-digit minute in the range <code>0..59</code>.
 #
 # Examples:
 #
@@ -290,8 +290,8 @@
 #
 # ### Single-Letter Offsets
 #
-# The zone value may be a  letter in the range `'A'..'I'` or `'K'..'Z'`; see
-# [List of military time
+# The zone value may be a  letter in the range <code>'A'..'I'</code> or
+# <code>'K'..'Z'</code>; see [List of military time
 # zones](https://en.wikipedia.org/wiki/List_of_military_time_zones):
 #
 #     t = Time.utc(2000, 1, 1, 20, 15, 1) # => 2000-01-01 20:15:01 UTC
@@ -304,7 +304,7 @@
 # ### Integer Offsets
 #
 # The zone value may be an integer number of seconds in the range
-# `-86399..86399`:
+# <code>-86399..86399</code>:
 #
 #     t = Time.utc(2000, 1, 1, 20, 15, 1) # => 2000-01-01 20:15:01 UTC
 #     Time.at(t, in: -86399)              # => 1999-12-31 20:15:02 -235959
@@ -321,7 +321,7 @@
 # *   `local_to_utc`:
 #
 #     Called when Time.new is invoked with `tz` as the value of positional
-#     argument `zone` or keyword argument `in:`.
+#     argument `zone` or keyword argument <code>in:</code>.
 #
 #     Argument
 # :       a [Time-like object](rdoc-ref:Time@Time-Like+Objects).
@@ -334,8 +334,9 @@
 # *   `utc_to_local`:
 #
 #     Called when Time.at or Time.now is invoked with `tz` as the value for
-#     keyword argument `in:`, and when Time#getlocal or Time#localtime is called
-#     with `tz` as the value for positional argument `zone`.
+#     keyword argument <code>in:</code>, and when Time#getlocal or
+#     Time#localtime is called with `tz` as the value for positional argument
+#     `zone`.
 #
 #     The UTC offset will be calculated as the difference between the original
 #     time and the returned object as an `Integer`. If the object is in fixed
@@ -354,7 +355,8 @@
 #
 # *   `abbr`:
 #
-#     Called when Time#strftime is invoked with a format involving `%Z`.
+#     Called when Time#strftime is invoked with a format involving
+#     <code>%Z</code>.
 #
 #     Argument
 # :       a [Time-like object](rdoc-ref:Time@Time-Like+Objects).
@@ -363,11 +365,12 @@
 # :       a string abbreviation for the timezone name.
 #
 #
-# *   `dst?`:
+# *   <code>dst?</code>:
 #
 #     Called when Time.at or Time.now is invoked with `tz` as the value for
-#     keyword argument `in:`, and when Time#getlocal or Time#localtime is called
-#     with `tz` as the value for positional argument `zone`.
+#     keyword argument <code>in:</code>, and when Time#getlocal or
+#     Time#localtime is called with `tz` as the value for positional argument
+#     `zone`.
 #
 #     Argument
 # :       a [Time-like object](rdoc-ref:Time@Time-Like+Objects).
@@ -378,7 +381,7 @@
 #
 # *   `name`:
 #
-#     Called when `Marshal.dump(t)` is invoked
+#     Called when <code>Marshal.dump(t)</code> is invoked
 #
 #     Argument
 # :       none.
@@ -472,7 +475,7 @@ class Time < Object
   # Required argument `time` may be either of:
   #
   # *   A `Time` object, whose value is the basis for the returned time; also
-  #     influenced by optional keyword argument `in:` (see below).
+  #     influenced by optional keyword argument <code>in:</code> (see below).
   # *   A numeric number of [Epoch seconds](rdoc-ref:Time@Epoch+Seconds) for the
   #     returned time.
   #
@@ -490,29 +493,29 @@ class Time < Object
   # together to specify subseconds for the returned time; argument `units`
   # specifies the units for `subsec`:
   #
-  # *   `:millisecond`: `subsec` in milliseconds:
+  # *   <code>:millisecond</code>: `subsec` in milliseconds:
   #
   #         Time.at(secs, 0, :millisecond)     # => 2000-12-31 23:59:59 -0600
   #         Time.at(secs, 500, :millisecond)   # => 2000-12-31 23:59:59.5 -0600
   #         Time.at(secs, 1000, :millisecond)  # => 2001-01-01 00:00:00 -0600
   #         Time.at(secs, -1000, :millisecond) # => 2000-12-31 23:59:58 -0600
   #
-  # *   `:microsecond` or `:usec`: `subsec` in microseconds:
+  # *   <code>:microsecond</code> or <code>:usec</code>: `subsec` in microseconds:
   #
   #         Time.at(secs, 0, :microsecond)        # => 2000-12-31 23:59:59 -0600
   #         Time.at(secs, 500000, :microsecond)   # => 2000-12-31 23:59:59.5 -0600
   #         Time.at(secs, 1000000, :microsecond)  # => 2001-01-01 00:00:00 -0600
   #         Time.at(secs, -1000000, :microsecond) # => 2000-12-31 23:59:58 -0600
   #
-  # *   `:nanosecond` or `:nsec`: `subsec` in nanoseconds:
+  # *   <code>:nanosecond</code> or <code>:nsec</code>: `subsec` in nanoseconds:
   #
   #         Time.at(secs, 0, :nanosecond)           # => 2000-12-31 23:59:59 -0600
   #         Time.at(secs, 500000000, :nanosecond)   # => 2000-12-31 23:59:59.5 -0600
   #         Time.at(secs, 1000000000, :nanosecond)  # => 2001-01-01 00:00:00 -0600
   #         Time.at(secs, -1000000000, :nanosecond) # => 2000-12-31 23:59:58 -0600
   #
-  # Optional keyword argument `in: zone` specifies the timezone for the returned
-  # time:
+  # Optional keyword argument <code>in: zone</code> specifies the timezone for the
+  # returned time:
   #
   #     Time.at(secs, in: '+12:00') # => 2001-01-01 17:59:59 +1200
   #     Time.at(secs, in: '-12:00') # => 2000-12-31 17:59:59 -1200
@@ -797,7 +800,7 @@ class Time < Object
   # -->
   # Compares `self` with `other_time`; returns:
   #
-  # *   `-1`, if `self` is less than `other_time`.
+  # *   <code>-1</code>, if `self` is less than `other_time`.
   # *   `0`, if `self` is equal to `other_time`.
   # *   `1`, if `self` is greater then `other_time`.
   # *   `nil`, if `self` and `other_time` are incomparable.
@@ -825,9 +828,9 @@ class Time < Object
   def >=: (Time arg0) -> bool
 
   # <!-- rdoc-file=time.c -->
-  # Returns a string representation of `self`, formatted by `strftime('%a %b %e %T
-  # %Y')` or its shorthand version `strftime('%c')`; see [Formats for Dates and
-  # Times](rdoc-ref:strftime_formatting.rdoc):
+  # Returns a string representation of `self`, formatted by <code>strftime('%a %b
+  # %e %T %Y')</code> or its shorthand version <code>strftime('%c')</code>; see
+  # [Formats for Dates and Times](rdoc-ref:strftime_formatting.rdoc):
   #
   #     t = Time.new(2000, 12, 31, 23, 59, 59, 0.5)
   #     t.ctime                      # => "Sun Dec 31 23:59:59 2000"
@@ -845,9 +848,9 @@ class Time < Object
   #   rdoc-file=time.c
   #   - ctime -> string
   # -->
-  # Returns a string representation of `self`, formatted by `strftime('%a %b %e %T
-  # %Y')` or its shorthand version `strftime('%c')`; see [Formats for Dates and
-  # Times](rdoc-ref:strftime_formatting.rdoc):
+  # Returns a string representation of `self`, formatted by <code>strftime('%a %b
+  # %e %T %Y')</code> or its shorthand version <code>strftime('%c')</code>; see
+  # [Formats for Dates and Times](rdoc-ref:strftime_formatting.rdoc):
   #
   #     t = Time.new(2000, 12, 31, 23, 59, 59, 0.5)
   #     t.ctime                      # => "Sun Dec 31 23:59:59 2000"
@@ -877,8 +880,10 @@ class Time < Object
   #   - deconstruct_keys(array_of_names_or_nil) -> hash
   # -->
   # Returns a hash of the name/value pairs, to use in pattern matching. Possible
-  # keys are: `:year`, `:month`, `:day`, `:yday`, `:wday`, `:hour`, `:min`,
-  # `:sec`, `:subsec`, `:dst`, `:zone`.
+  # keys are: <code>:year</code>, <code>:month</code>, <code>:day</code>,
+  # <code>:yday</code>, <code>:wday</code>, <code>:hour</code>, <code>:min</code>,
+  # <code>:sec</code>, <code>:subsec</code>, <code>:dst</code>,
+  # <code>:zone</code>.
   #
   # Possible usages:
   #
@@ -1135,9 +1140,9 @@ class Time < Object
   #         # => ["0", "1", "1", "0", "0", "0"]
   #         Time.new(*a) # => 0000-01-01 00:00:00 -0600
   #
-  # When positional argument `zone` or keyword argument `in:` is given, the new
-  # `Time` object is in the specified timezone. For the forms of argument `zone`,
-  # see [Timezone Specifiers](rdoc-ref:Time@Timezone+Specifiers):
+  # When positional argument `zone` or keyword argument <code>in:</code> is given,
+  # the new `Time` object is in the specified timezone. For the forms of argument
+  # `zone`, see [Timezone Specifiers](rdoc-ref:Time@Timezone+Specifiers):
   #
   #     Time.new(2000, 1, 1, 0, 0, 0, '+12:00')
   #     # => 2000-01-01 00:00:00 +1200
@@ -1146,9 +1151,9 @@ class Time < Object
   #     Time.new(in: '-12:00')
   #     # => 2022-08-23 08:49:26.1941467 -1200
   #
-  # Since `in:` keyword argument just provides the default, so if the first
-  # argument in single string form contains time zone information, this keyword
-  # argument will be silently ignored.
+  # Since <code>in:</code> keyword argument just provides the default, so if the
+  # first argument in single string form contains time zone information, this
+  # keyword argument will be silently ignored.
   #
   #     Time.new('2000-01-01 00:00:00 +0100', in: '-0500').utc_offset  # => 3600
   #

data/core/trace_point.rbs

@@ -21,62 +21,62 @@
 # If you don't specify the types of events you want to listen for, TracePoint
 # will include all available events.
 #
-# **Note:** Do not depend on the current event set, as this list is subject to
-# change. Instead, it is recommended to specify the types of events you want to
-# use.
+# <strong>Note:</strong> Do not depend on the current event set, as this list is
+# subject to change. Instead, it is recommended to specify the types of events
+# you want to use.
 #
 # To filter what is traced, you can pass any number of the following as
 # `events`:
 #
-# `:line`
+# <code>:line</code>
 # :   Execute an expression or statement on a new line.
 #
-# `:class`
+# <code>:class</code>
 # :   Start a class or module definition.
 #
-# `:end`
+# <code>:end</code>
 # :   Finish a class or module definition.
 #
-# `:call`
+# <code>:call</code>
 # :   Call a Ruby method.
 #
-# `:return`
+# <code>:return</code>
 # :   Return from a Ruby method.
 #
-# `:c_call`
+# <code>:c_call</code>
 # :   Call a C-language routine.
 #
-# `:c_return`
+# <code>:c_return</code>
 # :   Return from a C-language routine.
 #
-# `:raise`
+# <code>:raise</code>
 # :   Raise an exception.
 #
-# `:rescue`
+# <code>:rescue</code>
 # :   Rescue an exception.
 #
-# `:b_call`
+# <code>:b_call</code>
 # :   Event hook at block entry.
 #
-# `:b_return`
+# <code>:b_return</code>
 # :   Event hook at block ending.
 #
-# `:a_call`
+# <code>:a_call</code>
 # :   Event hook at all calls (`call`, `b_call`, and `c_call`).
 #
-# `:a_return`
+# <code>:a_return</code>
 # :   Event hook at all returns (`return`, `b_return`, and `c_return`).
 #
-# `:thread_begin`
+# <code>:thread_begin</code>
 # :   Event hook at thread beginning.
 #
-# `:thread_end`
+# <code>:thread_end</code>
 # :   Event hook at thread ending.
 #
-# `:fiber_switch`
+# <code>:fiber_switch</code>
 # :   Event hook at fiber switch.
 #
-# `:script_compiled`
+# <code>:script_compiled</code>
 # :   New Ruby code compiled (with `eval`, `load`, or `require`).
 #
 class TracePoint
@@ -140,7 +140,7 @@ class TracePoint
   #
   # If called when reentrance is already allowed, it raises a RuntimeError.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     # Without reentry
   #     # ---------------
@@ -223,8 +223,8 @@ class TracePoint
   # -->
   # Returns the generated binding object from the event.
   #
-  # Note that for `:c_call` and `:c_return` events, the method returns `nil`,
-  # since C methods themselves do not have bindings.
+  # Note that for <code>:c_call</code> and <code>:c_return</code> events, the
+  # method returns `nil`, since C methods themselves do not have bindings.
   #
   def binding: () -> Binding?
 
@@ -259,12 +259,13 @@ class TracePoint
   #       C.new.foo
   #     end
   #
-  # **Note:** #defined_class returns the singleton class.
+  # <strong>Note:</strong> #defined_class returns the singleton class.
   #
   # The 6th block parameter of Kernel#set_trace_func passes the original class
   # attached by the singleton class.
   #
-  # **This is a difference between Kernel#set_trace_func and TracePoint.**
+  # <strong>This is a difference between Kernel#set_trace_func and
+  # TracePoint.</strong>
   #
   #     class C; def self.foo; end; end
   #     trace = TracePoint.new(:call) do |tp|
@@ -432,8 +433,8 @@ class TracePoint
   #   rdoc-file=trace_point.rb
   #   - raised_exception()
   # -->
-  # Returns the exception raised on the `:raise` event or rescued on the `:rescue`
-  # event.
+  # Returns the exception raised on the <code>:raise</code> event or rescued on
+  # the <code>:rescue</code> event.
   #
   def raised_exception: () -> Exception
 
@@ -441,7 +442,8 @@ class TracePoint
   #   rdoc-file=trace_point.rb
   #   - return_value()
   # -->
-  # Returns the return value from `:return`, `:c_return`, and `:b_return` events.
+  # Returns the return value from <code>:return</code>, <code>:c_return</code>,
+  # and <code>:b_return</code> events.
   #
   def return_value: () -> untyped
 
@@ -452,7 +454,7 @@ class TracePoint
   # Returns the trace object during the event.
   #
   # Similar to the following, but it returns the correct object (the method
-  # receiver) for `:c_call` and `:c_return` events:
+  # receiver) for <code>:c_call</code> and <code>:c_return</code> events:
   #
   #     trace.binding.eval('self')
   #
@@ -463,7 +465,7 @@ class TracePoint
   #   - eval_script()
   # -->
   # Returns the compiled source code (String) from eval methods on the
-  # `:script_compiled` event. If loaded from a file, it returns `nil`.
+  # <code>:script_compiled</code> event. If loaded from a file, it returns `nil`.
   #
   def eval_script: () -> String?
 
@@ -472,7 +474,8 @@ class TracePoint
   #   - instruction_sequence()
   # -->
   # Returns the compiled instruction sequence represented by a
-  # RubyVM::InstructionSequence instance on the `:script_compiled` event.
+  # RubyVM::InstructionSequence instance on the <code>:script_compiled</code>
+  # event.
   #
   # Note that this method is CRuby-specific.
   #

data/core/true_class.rbs

@@ -58,7 +58,7 @@ class TrueClass
        | (untyped obj) -> bool
 
   # <!-- rdoc-file=object.c -->
-  # Returns string `'true'`:
+  # Returns string <code>'true'</code>:
   #
   #     true.to_s # => "true"
   #
@@ -70,7 +70,7 @@ class TrueClass
   #   rdoc-file=object.c
   #   - true.to_s -> 'true'
   # -->
-  # Returns string `'true'`:
+  # Returns string <code>'true'</code>:
   #
   #     true.to_s # => "true"
   #

data/core/unbound_method.rbs

@@ -150,7 +150,7 @@ class UnboundMethod
   #   - umeth.bind(obj) -> method
   # -->
   # Bind *umeth* to *obj*. If Klass was the class from which *umeth* was obtained,
-  # `obj.kind_of?(Klass)` must be true.
+  # <code>obj.kind_of?(Klass)</code> must be true.
   #
   #     class A
   #       def test
@@ -170,7 +170,7 @@ class UnboundMethod
   #     bm = um.bind(A.new)
   #     bm.call
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     In test, class = C
   #     In test, class = B
@@ -199,12 +199,12 @@ class UnboundMethod
   #     Net::HTTP.method(:get).inspect
   #     #=> "#<Method: Net::HTTP.get(uri_or_host, path=..., port=...) <skip>/lib/ruby/2.7.0/net/http.rb:457>"
   #
-  # `...` in argument definition means argument is optional (has some default
-  # value).
+  # <code>...</code> in argument definition means argument is optional (has some
+  # default value).
   #
   # For methods defined in C (language core and extensions), location and argument
   # names can't be extracted, and only generic information is provided in form of
-  # `*` (any number of arguments) or `_` (some positional argument).
+  # <code>*</code> (any number of arguments) or `_` (some positional argument).
   #
   #     "cat".method(:count).inspect   #=> "#<Method: String#count(*)>"
   #     "cat".method(:+).inspect       #=> "#<Method: String#+(_)>""
@@ -227,12 +227,12 @@ class UnboundMethod
   #     Net::HTTP.method(:get).inspect
   #     #=> "#<Method: Net::HTTP.get(uri_or_host, path=..., port=...) <skip>/lib/ruby/2.7.0/net/http.rb:457>"
   #
-  # `...` in argument definition means argument is optional (has some default
-  # value).
+  # <code>...</code> in argument definition means argument is optional (has some
+  # default value).
   #
   # For methods defined in C (language core and extensions), location and argument
   # names can't be extracted, and only generic information is provided in form of
-  # `*` (any number of arguments) or `_` (some positional argument).
+  # <code>*</code> (any number of arguments) or `_` (some positional argument).
   #
   #     "cat".method(:count).inspect   #=> "#<Method: String#count(*)>"
   #     "cat".method(:+).inspect       #=> "#<Method: String#+(_)>""
@@ -330,8 +330,8 @@ class UnboundMethod
   #   - umeth.bind_call(recv, args, ...) -> obj
   # -->
   # Bind *umeth* to *recv* and then invokes the method with the specified
-  # arguments. This is semantically equivalent to `umeth.bind(recv).call(args,
-  # ...)`.
+  # arguments. This is semantically equivalent to
+  # <code>umeth.bind(recv).call(args, ...)</code>.
   #
   def bind_call: (untyped recv, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
 end

data/core/warning.rbs

@@ -5,11 +5,11 @@
 #
 # Changing the behavior of Warning.warn is useful to customize how warnings are
 # handled by Ruby, for instance by filtering some warnings, and/or outputting
-# warnings somewhere other than `$stderr`.
+# warnings somewhere other than <code>$stderr</code>.
 #
 # If you want to change the behavior of Warning.warn you should use
-# `Warning.extend(MyNewModuleWithWarnMethod)` and you can use `super` to get the
-# default behavior of printing the warning to `$stderr`.
+# <code>Warning.extend(MyNewModuleWithWarnMethod)</code> and you can use `super`
+# to get the default behavior of printing the warning to <code>$stderr</code>.
 #
 # Example:
 #     module MyWarningFilter
@@ -41,18 +41,18 @@ module Warning
   # Returns the flag to show the warning messages for `category`. Supported
   # categories are:
   #
-  # `:deprecated`
+  # <code>:deprecated</code>
   # :   deprecation warnings
-  #     *   assignment of non-nil value to `$,` and `$;`
+  #     *   assignment of non-nil value to <code>$,</code> and <code>$;</code>
   #     *   keyword arguments
   #     etc.
   #
   #
-  # `:experimental`
+  # <code>:experimental</code>
   # :   experimental features
   #
   #
-  # `:performance`
+  # <code>:performance</code>
   # :   performance hints
   #     *   Shape variation limit
   #

data/docs/collection.md

@@ -189,4 +189,4 @@ If the gem's RBS is included in the gem package, put it as `sig/manifest.yaml`.
 ## How it works
 
 `rbs collection` is integrated with Bundler.
-`rbs collection install` command generates `gem_rbs_collection.lock.yaml` from `gem_rbs_collection.yaml` and `Gemfile.lock`. It uses `Gemfile.lock` to detects dependencies.
+`rbs collection install` command generates `rbs_collection.lock.yaml` from `rbs_collection.yaml` and `Gemfile.lock`. It uses `Gemfile.lock` to detects dependencies.