rbs 3.6.1 → 3.9.5

data/core/match_data.rbs

@@ -41,7 +41,6 @@
 # *   `$'` is Regexp.last_match`.post_match`;
 # *   `$+` is Regexp.last_match`[ -1 ]` (the last capture).
 #
-#
 # See also "Special global variables" section in Regexp documentation.
 #
 class MatchData
@@ -133,6 +132,82 @@ class MatchData
   #
   def begin: (capture backref) -> Integer?
 
+  # <!--
+  #   rdoc-file=re.c
+  #   - bytebegin(n) -> integer
+  #   - bytebegin(name) -> integer
+  # -->
+  # Returns the offset (in bytes) of the beginning of the specified match.
+  #
+  # When non-negative integer argument `n` is given, returns the offset of the
+  # beginning of the `n`th match:
+  #
+  #     m = /(.)(.)(\d+)(\d)/.match("THX1138.")
+  #     # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
+  #     m[0]       # => "HX1138"
+  #     m.bytebegin(0) # => 1
+  #     m[3]       # => "113"
+  #     m.bytebegin(3) # => 3
+  #
+  #     m = /(т)(е)(с)/.match('тест')
+  #     # => #<MatchData "тес" 1:"т" 2:"е" 3:"с">
+  #     m[0]       # => "тес"
+  #     m.bytebegin(0) # => 0
+  #     m[3]       # => "с"
+  #     m.bytebegin(3) # => 4
+  #
+  # When string or symbol argument `name` is given, returns the offset of the
+  # beginning for the named match:
+  #
+  #     m = /(?<foo>.)(.)(?<bar>.)/.match("hoge")
+  #     # => #<MatchData "hog" foo:"h" bar:"g">
+  #     m[:foo]        # => "h"
+  #     m.bytebegin('foo') # => 0
+  #     m[:bar]        # => "g"
+  #     m.bytebegin(:bar)  # => 2
+  #
+  # Related: MatchData#byteend, MatchData#byteoffset.
+  #
+  def bytebegin: (capture backref) -> Integer?
+
+  # <!--
+  #   rdoc-file=re.c
+  #   - byteend(n) -> integer
+  #   - byteend(name) -> integer
+  # -->
+  # Returns the offset (in bytes) of the end of the specified match.
+  #
+  # When non-negative integer argument `n` is given, returns the offset of the end
+  # of the `n`th match:
+  #
+  #     m = /(.)(.)(\d+)(\d)/.match("THX1138.")
+  #     # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
+  #     m[0]     # => "HX1138"
+  #     m.byteend(0) # => 7
+  #     m[3]     # => "113"
+  #     m.byteend(3) # => 6
+  #
+  #     m = /(т)(е)(с)/.match('тест')
+  #     # => #<MatchData "тес" 1:"т" 2:"е" 3:"с">
+  #     m[0]     # => "тес"
+  #     m.byteend(0) # => 6
+  #     m[3]     # => "с"
+  #     m.byteend(3) # => 6
+  #
+  # When string or symbol argument `name` is given, returns the offset of the end
+  # for the named match:
+  #
+  #     m = /(?<foo>.)(.)(?<bar>.)/.match("hoge")
+  #     # => #<MatchData "hog" foo:"h" bar:"g">
+  #     m[:foo]      # => "h"
+  #     m.byteend('foo') # => 1
+  #     m[:bar]      # => "g"
+  #     m.byteend(:bar)  # => 3
+  #
+  # Related: MatchData#bytebegin, MatchData#byteoffset.
+  #
+  def byteend: (capture backref) -> Integer?
+
   # <!--
   #   rdoc-file=re.c
   #   - mtch.byteoffset(n)   -> array
@@ -544,7 +619,6 @@ class MatchData
   # *   Ranges.
   # *   Names (strings and symbols).
   #
-  #
   # Examples:
   #
   #     m = /(.)(.)(\d+)(\d)/.match("THX1138: The Movie")

data/core/math.rbs

@@ -37,7 +37,6 @@
 #
 #         [1.0, INFINITY)
 #
-#
 # Many values returned by Math methods are numerical approximations. This is
 # because many such values are, in mathematics, of infinite precision, while in
 # numerical computation the precision is finite.
@@ -64,7 +63,6 @@
 # *   ::sin: Returns the sine of the given argument.
 # *   ::tan: Returns the tangent of the given argument.
 #
-#
 # #### Inverse Trigonometric Functions
 #
 # *   ::acos: Returns the arc cosine of the given argument.
@@ -72,21 +70,18 @@
 # *   ::atan: Returns the arc tangent of the given argument.
 # *   ::atan2: Returns the arg tangent of two given arguments.
 #
-#
 # #### Hyperbolic Trigonometric Functions
 #
 # *   ::cosh: Returns the hyperbolic cosine of the given argument.
 # *   ::sinh: Returns the hyperbolic sine of the given argument.
 # *   ::tanh: Returns the hyperbolic tangent of the given argument.
 #
-#
 # #### Inverse Hyperbolic Trigonometric Functions
 #
 # *   ::acosh: Returns the inverse hyperbolic cosine of the given argument.
 # *   ::asinh: Returns the inverse hyperbolic sine of the given argument.
 # *   ::atanh: Returns the inverse hyperbolic tangent of the given argument.
 #
-#
 # #### Exponentiation and Logarithmic Functions
 #
 # *   ::exp: Returns the value of a given value raised to a given power.
@@ -94,19 +89,16 @@
 # *   ::log10: Returns the base 10 logarithm of the given argument.
 # *   ::log2: Returns the base 2 logarithm of the given argument.
 #
-#
 # #### Fraction and Exponent Functions
 #
 # *   ::frexp: Returns the fraction and exponent of the given argument.
 # *   ::ldexp: Returns the value for a given fraction and exponent.
 #
-#
 # #### Root Functions
 #
 # *   ::cbrt: Returns the cube root of the given argument.
 # *   ::sqrt: Returns the square root of the given argument.
 #
-#
 # #### Error Functions
 #
 # *   ::erf: Returns the value of the Gauss error function for the given
@@ -114,14 +106,12 @@
 # *   ::erfc: Returns the value of the complementary error function for the
 #     given argument.
 #
-#
 # #### Gamma Functions
 #
 # *   ::gamma: Returns the value of the gamma function for the given argument.
 # *   ::lgamma: Returns the value of the logarithmic gamma function for the
 #     given argument.
 #
-#
 # #### Hypotenuse Function
 #
 # *   ::hypot: Returns `sqrt(a**2 + b**2)` for the given `a` and `b`.
@@ -168,7 +158,6 @@ module Math
   # *   Domain: `[-1, 1]`.
   # *   Range: `[0, PI]`.
   #
-  #
   # Examples:
   #
   #     acos(-1.0) # => 3.141592653589793  # PI
@@ -187,7 +176,6 @@ module Math
   # *   Domain: `[1, INFINITY]`.
   # *   Range: `[0, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     acosh(1.0)      # => 0.0
@@ -205,7 +193,6 @@ module Math
   # *   Domain: `[-1, -1]`.
   # *   Range: `[-PI/2, PI/2]`.
   #
-  #
   # Examples:
   #
   #     asin(-1.0) # => -1.5707963267948966 # -PI/2
@@ -224,7 +211,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     asinh(-INFINITY) # => -Infinity
@@ -244,7 +230,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-PI/2, PI/2]  `.
   #
-  #
   # Examples:
   #
   #     atan(-INFINITY) # => -1.5707963267948966 # -PI2
@@ -270,7 +255,6 @@ module Math
   # *   Domain of `x`: `[-INFINITY, INFINITY]`.
   # *   Range: `[-PI, PI]`.
   #
-  #
   # Examples:
   #
   #     atan2(-1.0, -1.0) # => -2.356194490192345  # -3*PI/4
@@ -290,7 +274,6 @@ module Math
   # *   Domain: `[-1, 1]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     atanh(-1.0) # => -Infinity
@@ -308,7 +291,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     cbrt(-INFINITY) # => -Infinity
@@ -336,7 +318,6 @@ module Math
   # *   Domain: `(-INFINITY, INFINITY)`.
   # *   Range: `[-1.0, 1.0]`.
   #
-  #
   # Examples:
   #
   #     cos(-PI)   # => -1.0
@@ -359,7 +340,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[1, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     cosh(-INFINITY) # => Infinity
@@ -378,7 +358,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-1, 1]`.
   #
-  #
   # Examples:
   #
   #     erf(-INFINITY) # => -1.0
@@ -400,7 +379,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[0, 2]`.
   #
-  #
   # Examples:
   #
   #     erfc(-INFINITY) # => 2.0
@@ -420,7 +398,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[0, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     exp(-INFINITY) # => 0.0
@@ -449,7 +426,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     frexp(-INFINITY) # => [-Infinity, -1]
@@ -474,7 +450,6 @@ module Math
   # *   Domain: `(-INFINITY, INFINITY]` excluding negative integers.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     gamma(-2.5)      # => -0.9453087204829431
@@ -502,7 +477,6 @@ module Math
   # *   Domain of +ab: `[-INFINITY, INFINITY]`.
   # *   Range: `[0, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     hypot(0.0, 1.0)       # => 1.0
@@ -525,7 +499,6 @@ module Math
   # *   Domain of `fraction`: `[0.0, 1.0)`.
   # *   Domain of `exponent`: `[0, 1024]` (larger values are equivalent to 1024).
   #
-  #
   # See [IEEE 754 double-precision binary floating-point format:
   # binary64](https://en.wikipedia.org/wiki/Double-precision_floating-point_format
   # #IEEE_754_double-precision_binary_floating-point_format:_binary64).
@@ -560,7 +533,6 @@ module Math
   # *   Range of first element: `(-INFINITY, INFINITY]`.
   # *   Second element is -1 or 1.
   #
-  #
   # Examples:
   #
   #     lgamma(-4.0) # => [Infinity, -1]
@@ -595,7 +567,6 @@ module Math
   # *   Domain: `[0, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY)]`.
   #
-  #
   # Examples:
   #
   #     log(0.0)        # => -Infinity
@@ -623,7 +594,6 @@ module Math
   # *   Domain: `[0, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     log10(0.0)      # => -Infinity
@@ -643,7 +613,6 @@ module Math
   # *   Domain: `[0, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     log2(0.0)      # => -Infinity
@@ -664,7 +633,6 @@ module Math
   # *   Domain: `(-INFINITY, INFINITY)`.
   # *   Range: `[-1.0, 1.0]`.
   #
-  #
   # Examples:
   #
   #     sin(-PI)   # => -1.2246063538223773e-16 # -0.0000000000000001
@@ -687,7 +655,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-INFINITY, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     sinh(-INFINITY) # => -Infinity
@@ -706,7 +673,6 @@ module Math
   # *   Domain: `[0, INFINITY]`.
   # *   Range: `[0, INFINITY]`.
   #
-  #
   # Examples:
   #
   #     sqrt(0.0)      # => 0.0
@@ -731,7 +697,6 @@ module Math
   # *   Domain: `(-INFINITY, INFINITY)`.
   # *   Range: `(-INFINITY, INFINITY)`.
   #
-  #
   # Examples:
   #
   #     tan(-PI)   # => 1.2246467991473532e-16  # -0.0000000000000001
@@ -754,7 +719,6 @@ module Math
   # *   Domain: `[-INFINITY, INFINITY]`.
   # *   Range: `[-1, 1]`.
   #
-  #
   # Examples:
   #
   #     tanh(-INFINITY) # => -1.0

data/core/method.rbs

@@ -54,7 +54,7 @@ class Method
   #
   def hash: () -> Integer
 
-  def dup: () -> instance
+  def dup: () -> self
 
   # <!--
   #   rdoc-file=proc.c
@@ -252,7 +252,7 @@ class Method
   #     m.call # => "bar"
   #     n = m.clone.call # => "bar"
   #
-  def clone: () -> instance
+  def clone: () -> self
 
   # <!--
   #   rdoc-file=proc.c

data/core/module.rbs

@@ -315,14 +315,14 @@ class Module < Object
   #   rdoc-file=load.c
   #   - mod.autoload(const, filename)   -> nil
   # -->
-  # Registers _filename_ to be loaded (using Kernel::require)
-  #     the first time that _const_ (which may be a String or
-  #     a symbol) is accessed in the namespace of _mod_.
+  # Registers *filename* to be loaded (using Kernel::require) the first time that
+  # *const* (which may be a String or a symbol) is accessed in the namespace of
+  # *mod*.
   #
-  #        module A
-  #        end
-  #        A.autoload(:B, "b")
-  #        A::B.doit            # autoloads "b"
+  #     module A
+  #     end
+  #     A.autoload(:B, "b")
+  #     A::B.doit            # autoloads "b"
   #
   # If *const* in *mod* is defined as autoload, the file name to be loaded is
   # replaced with *filename*.  If *const* is defined but not as autoload, does
@@ -574,7 +574,7 @@ class Module < Object
   # -->
   # Invoked when a reference is made to an undefined constant in *mod*. It is
   # passed a symbol for the undefined constant, and returns a value to be used for
-  # that constant. The following code is an example of the same:
+  # that constant. For example, consider:
   #
   #     def Foo.const_missing(name)
   #       name # return the constant name as Symbol
@@ -582,22 +582,27 @@ class Module < Object
   #
   #     Foo::UNDEFINED_CONST    #=> :UNDEFINED_CONST: symbol returned
   #
-  # In the next example when a reference is made to an undefined constant, it
-  # attempts to load a file whose name is the lowercase version of the constant
-  # (thus class `Fred` is assumed to be in file `fred.rb`).  If found, it returns
-  # the loaded class. It therefore implements an autoload feature similar to
-  # Kernel#autoload and Module#autoload.
+  # As the example above shows, `const_missing` is not required to create the
+  # missing constant in *mod*, though that is often a side-effect. The caller gets
+  # its return value when triggered. If the constant is also defined, further
+  # lookups won't hit `const_missing` and will return the value stored in the
+  # constant as usual. Otherwise, `const_missing` will be invoked again.
+  #
+  # In the next example, when a reference is made to an undefined constant,
+  # `const_missing` attempts to load a file whose path is the lowercase version of
+  # the constant name (thus class `Fred` is assumed to be in file `fred.rb`). If
+  # defined as a side-effect of loading the file, the method returns the value
+  # stored in the constant. This implements an autoload feature similar to
+  # Kernel#autoload and Module#autoload, though it differs in important ways.
   #
   #     def Object.const_missing(name)
   #       @looked_for ||= {}
   #       str_name = name.to_s
-  #       raise "Class not found: #{name}" if @looked_for[str_name]
+  #       raise "Constant not found: #{name}" if @looked_for[str_name]
   #       @looked_for[str_name] = 1
   #       file = str_name.downcase
   #       require file
-  #       klass = const_get(name)
-  #       return klass if klass
-  #       raise "Class not found: #{name}"
+  #       const_get(name, false)
   #     end
   #
   def const_missing: (Symbol arg0) -> untyped
@@ -726,8 +731,8 @@ class Module < Object
   #     I'm Dino!
   #     #<B:0x401b39e8>
   #
-  def define_method: (interned symbol, ^() [self: instance] -> untyped | Method | UnboundMethod method) -> Symbol
-                   | (interned symbol) { () [self: instance] -> untyped } -> Symbol
+  def define_method: (interned symbol, ^(?) [self: top] -> untyped | Method | UnboundMethod method) -> Symbol
+                   | (interned symbol) { (?) [self: top] -> untyped } -> Symbol
 
   # <!--
   #   rdoc-file=object.c
@@ -1155,11 +1160,11 @@ class Module < Object
 
   # <!--
   #   rdoc-file=object.c
-  #   - mod.name    -> string
+  #   - mod.name    -> string or nil
   # -->
-  # Returns the name of the module *mod*.  Returns nil for anonymous modules.
+  # Returns the name of the module *mod*.  Returns `nil` for anonymous modules.
   #
-  def name: () -> String?
+  def name: %a{implicitly-returns-nil} () -> String
 
   # <!--
   #   rdoc-file=eval.c
@@ -1482,7 +1487,7 @@ class Module < Object
   #   rdoc-file=eval.c
   #   - refinements -> array
   # -->
-  # Returns an array of modules defined within the receiver.
+  # Returns an array of `Refinement` defined within the receiver.
   #
   #     module A
   #       refine Integer do
@@ -1549,8 +1554,8 @@ class Module < Object
   # of the module and the values that are related to it, such as instances,
   # constants, and methods.
   #
-  # The name should be `nil` or non-empty string that is not a valid constant name
-  # (to avoid confusing between permanent and temporary names).
+  # The name should be `nil` or a non-empty string that is not a valid constant
+  # path (to avoid confusing between permanent and temporary names).
   #
   # The method can be useful to distinguish dynamically generated classes and
   # modules without assigning them to constants.
@@ -1651,7 +1656,7 @@ class Module < Object
   #
   #     In child
   #     In parent
-  #     prog.rb:23: undefined method `hello' for #<Child:0x401b3bb4> (NoMethodError)
+  #     prog.rb:23: undefined method 'hello' for #<Child:0x401b3bb4> (NoMethodError)
   #
   def undef_method: (*interned arg0) -> self
 
@@ -1694,6 +1699,6 @@ class Module < Object
   def attr: (*interned arg0) -> Array[Symbol]
 
   # A previous incarnation of `interned` for backward-compatibility (see #1499)
-  %a{steep:deprecated}
+  %a{deprecated: Use `interned`}
   type id = interned
 end

data/core/nil_class.rbs

@@ -9,7 +9,6 @@
 # *   #=~
 # *   #^
 #
-#
 # Others act as converters, carrying the concept of *nullity* to other classes:
 #
 # *   #rationalize
@@ -19,12 +18,13 @@
 # *   #to_r
 # *   #to_s
 #
+# While `nil` doesn't have an explicitly defined #to_hash method, it can be used
+# in `**` unpacking, not adding any keyword arguments.
 #
 # Another method provides inspection:
 #
 # *   #inspect
 #
-#
 # Finally, there is this query method:
 #
 # *   #nil?