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

data/core/basic_object.rbs

@@ -17,7 +17,8 @@
 # *   Do not have namespace "pollution" from the many methods provided in class
 #     Object and its included module Kernel.
 # *   Do not have definitions of common classes, and so references to such
-#     common classes must be fully qualified (`::String`, not `String`).
+#     common classes must be fully qualified (<code>::String</code>, not
+#     `String`).
 #
 # A variety of strategies can be used to provide useful portions of the Standard
 # Library in subclasses of `BasicObject`:
@@ -92,8 +93,8 @@ class BasicObject
   # classes to provide class-specific meaning.
   #
   # Unlike #==, the #equal? method should never be overridden by subclasses as it
-  # is used to determine object identity (that is, `a.equal?(b)` if and only if
-  # `a` is the same object as `b`):
+  # is used to determine object identity (that is, <code>a.equal?(b)</code> if and
+  # only if `a` is the same object as `b`):
   #
   #     obj = "a"
   #     other = obj.dup
@@ -174,8 +175,8 @@ class BasicObject
   # classes to provide class-specific meaning.
   #
   # Unlike #==, the #equal? method should never be overridden by subclasses as it
-  # is used to determine object identity (that is, `a.equal?(b)` if and only if
-  # `a` is the same object as `b`):
+  # is used to determine object identity (that is, <code>a.equal?(b)</code> if and
+  # only if `a` is the same object as `b`):
   #
   #     obj = "a"
   #     other = obj.dup
@@ -315,7 +316,7 @@ class BasicObject
   #       def Chatty.three() end
   #     end
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     Adding singleton_method_added
   #     Adding one
@@ -343,7 +344,7 @@ class BasicObject
   #       end
   #     end
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     Removing three
   #     Removing one
@@ -367,7 +368,7 @@ class BasicObject
   #       end
   #     end
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     Undefining one
   #

data/core/class.rbs

@@ -10,8 +10,9 @@
 # When a new class is created, an object of type Class is initialized and
 # assigned to a global constant (Name in this case).
 #
-# When `Name.new` is called to create a new object, the #new method in Class is
-# run by default. This can be demonstrated by overriding #new in Class:
+# When <code>Name.new</code> is called to create a new object, the #new method
+# in Class is run by default. This can be demonstrated by overriding #new in
+# Class:
 #
 #     class Class
 #       alias old_new new
@@ -26,7 +27,7 @@
 #
 #     n = Name.new
 #
-# *produces:*
+# <em>produces:</em>
 #
 #     Creating a new Name
 #
@@ -144,7 +145,7 @@ class Class < Module
   #     class Baz < Bar
   #     end
   #
-  # *produces:*
+  # <em>produces:</em>
   #
   #     New subclass: Bar
   #     New subclass: Baz
@@ -157,7 +158,7 @@ class Class < Module
   # -->
   # Calls #allocate to create a new object of *class*'s class, then invokes that
   # object's #initialize method, passing it *args*.  This is the method that ends
-  # up getting called whenever an object is constructed using `.new`.
+  # up getting called whenever an object is constructed using <code>.new</code>.
   #
   def new: () -> untyped
 

data/core/comparable.rbs

@@ -1,12 +1,13 @@
 # <!-- rdoc-file=compar.c -->
 # The Comparable mixin is used by classes whose objects may be ordered. The
-# class must define the `<=>` operator, which compares the receiver against
-# another object, returning a value less than 0, returning 0, or returning a
-# value greater than 0, depending on whether the receiver is less than, equal
-# to, or greater than the other object. If the other object is not comparable
-# then the `<=>` operator should return `nil`. Comparable uses `<=>` to
-# implement the conventional comparison operators (`<`, `<=`, `==`, `>=`, and
-# `>`) and the method `between?`.
+# class must define the <code><=></code> operator, which compares the receiver
+# against another object, returning a value less than 0, returning 0, or
+# returning a value greater than 0, depending on whether the receiver is less
+# than, equal to, or greater than the other object. If the other object is not
+# comparable then the <code><=></code> operator should return `nil`. Comparable
+# uses <code><=></code> to implement the conventional comparison operators
+# (<code><</code>, <code><=</code>, <code>==</code>, <code>>=</code>, and
+# <code>></code>) and the method <code>between?</code>.
 #
 #     class StringSorter
 #       include Comparable
@@ -38,7 +39,8 @@
 #
 # ## What's Here
 #
-# Module Comparable provides these methods, all of which use method `#<=>`:
+# Module Comparable provides these methods, all of which use method
+# <code>#<=></code>:
 #
 # *   #<: Returns whether `self` is less than the given object.
 # *   #<=: Returns whether `self` is less than or equal to the given object.
@@ -46,10 +48,11 @@
 # *   #>: Returns whether `self` is greater than the given object.
 # *   #>=: Returns whether `self` is greater than or equal to the given object.
 # *   #between?: Returns `true` if `self` is between two given objects.
-# *   #clamp: For given objects `min` and `max`, or range `(min..max)`, returns:
+# *   #clamp: For given objects `min` and `max`, or range
+#     <code>(min..max)</code>, returns:
 #
-#     *   `min` if `(self <=> min) < 0`.
-#     *   `max` if `(self <=> max) > 0`.
+#     *   `min` if <code>(self <=> min) < 0</code>.
+#     *   `max` if <code>(self <=> max) > 0</code>.
 #     *   `self` otherwise.
 #
 module Comparable : _WithSpaceshipOperator
@@ -57,8 +60,8 @@ module Comparable : _WithSpaceshipOperator
   #   rdoc-file=compar.c
   #   - self < other -> true or false
   # -->
-  # Returns whether `self` is "less than" `other`; equivalent to `(self <=> other)
-  # < 0`:
+  # Returns whether `self` is "less than" `other`; equivalent to <code>(self <=>
+  # other) < 0</code>:
   #
   #     'foo' < 'foo'  # => false
   #     'foo' < 'food' # => true
@@ -70,7 +73,7 @@ module Comparable : _WithSpaceshipOperator
   #   - self <= other -> true or false
   # -->
   # Returns whether `self` is "less than or equal to" `other`; equivalent to
-  # `(self <=> other) <= 0`:
+  # <code>(self <=> other) <= 0</code>:
   #
   #     'foo' <= 'foo'  # => true
   #     'foo' <= 'food' # => true
@@ -82,8 +85,9 @@ module Comparable : _WithSpaceshipOperator
   #   rdoc-file=compar.c
   #   - obj == other    -> true or false
   # -->
-  # Compares two objects based on the receiver's `<=>` method, returning true if
-  # it returns 0. Also returns true if *obj* and *other* are the same object.
+  # Compares two objects based on the receiver's <code><=></code> method,
+  # returning true if it returns 0. Also returns true if *obj* and *other* are the
+  # same object.
   #
   def ==: (untyped other) -> bool
 
@@ -91,8 +95,8 @@ module Comparable : _WithSpaceshipOperator
   #   rdoc-file=compar.c
   #   - obj > other    -> true or false
   # -->
-  # Compares two objects based on the receiver's `<=>` method, returning true if
-  # it returns a value greater than 0.
+  # Compares two objects based on the receiver's <code><=></code> method,
+  # returning true if it returns a value greater than 0.
   #
   def >: (untyped other) -> bool
 
@@ -100,8 +104,8 @@ module Comparable : _WithSpaceshipOperator
   #   rdoc-file=compar.c
   #   - obj >= other    -> true or false
   # -->
-  # Compares two objects based on the receiver's `<=>` method, returning true if
-  # it returns a value greater than or equal to 0.
+  # Compares two objects based on the receiver's <code><=></code> method,
+  # returning true if it returns a value greater than or equal to 0.
   #
   def >=: (untyped other) -> bool
 
@@ -109,8 +113,8 @@ module Comparable : _WithSpaceshipOperator
   #   rdoc-file=compar.c
   #   - obj.between?(min, max)    -> true or false
   # -->
-  # Returns `false` if *obj* `<=>` *min* is less than zero or if *obj* `<=>` *max*
-  # is greater than zero, `true` otherwise.
+  # Returns `false` if *obj* <code><=></code> *min* is less than zero or if *obj*
+  # <code><=></code> *max* is greater than zero, `true` otherwise.
   #
   #     3.between?(1, 5)               #=> true
   #     6.between?(1, 5)               #=> false
@@ -124,8 +128,9 @@ module Comparable : _WithSpaceshipOperator
   #   - obj.clamp(min, max) ->  obj
   #   - obj.clamp(range)    ->  obj
   # -->
-  # In `(min, max)` form, returns *min* if *obj* `<=>` *min* is less than zero,
-  # *max* if *obj* `<=>` *max* is greater than zero, and *obj* otherwise.
+  # In <code>(min, max)</code> form, returns *min* if *obj* <code><=></code> *min*
+  # is less than zero, *max* if *obj* <code><=></code> *max* is greater than zero,
+  # and *obj* otherwise.
   #
   #     12.clamp(0, 100)         #=> 12
   #     523.clamp(0, 100)        #=> 100
@@ -140,9 +145,10 @@ module Comparable : _WithSpaceshipOperator
   #     -20.clamp(0, nil)           #=> 0
   #     523.clamp(nil, 100)         #=> 100
   #
-  # In `(range)` form, returns *range.begin* if *obj* `<=>` *range.begin* is less
-  # than zero, *range.end* if *obj* `<=>` *range.end* is greater than zero, and
-  # *obj* otherwise.
+  # In <code>(range)</code> form, returns <em>range.begin</em> if *obj*
+  # <code><=></code> <em>range.begin</em> is less than zero, <em>range.end</em> if
+  # *obj* <code><=></code> <em>range.end</em> is greater than zero, and *obj*
+  # otherwise.
   #
   #     12.clamp(0..100)         #=> 12
   #     523.clamp(0..100)        #=> 100
@@ -151,13 +157,13 @@ module Comparable : _WithSpaceshipOperator
   #     'd'.clamp('a'..'f')      #=> 'd'
   #     'z'.clamp('a'..'f')      #=> 'f'
   #
-  # If *range.begin* is `nil`, it is considered smaller than *obj*, and if
-  # *range.end* is `nil`, it is considered greater than *obj*.
+  # If <em>range.begin</em> is `nil`, it is considered smaller than *obj*, and if
+  # <em>range.end</em> is `nil`, it is considered greater than *obj*.
   #
   #     -20.clamp(0..)           #=> 0
   #     523.clamp(..100)         #=> 100
   #
-  # When *range.end* is excluded and not `nil`, an exception is raised.
+  # When <em>range.end</em> is excluded and not `nil`, an exception is raised.
   #
   #     100.clamp(0...100)       # ArgumentError
   #
@@ -174,5 +180,13 @@ interface Comparable::_WithSpaceshipOperator
   # If `other` is less than `self`, it returns a positive Integer.
   # If no comparison is defined with `other` and `self`, it returns `nil`.
   #
-  def <=>: (untyped other) -> Integer?
+  def <=>: (untyped other) -> Comparable::_CompareToZero?
+end
+
+# This interface indicates a type is comparable against zero.
+#
+interface Comparable::_CompareToZero
+  def <: (0) -> boolish
+
+  def >: (0) -> boolish
 end

data/core/complex.rbs

@@ -79,17 +79,19 @@
 # *   #arg (and its aliases #angle and #phase): Returns the argument (angle) for
 #     `self` in radians.
 # *   #denominator: Returns the denominator of `self`.
-# *   #finite?: Returns whether both `self.real` and `self.image` are finite.
+# *   #finite?: Returns whether both <code>self.real</code> and
+#     <code>self.image</code> are finite.
 # *   #hash: Returns the integer hash value for `self`.
 # *   #imag (and its alias #imaginary): Returns the imaginary value for `self`.
-# *   #infinite?: Returns whether `self.real` or `self.image` is infinite.
+# *   #infinite?: Returns whether <code>self.real</code> or
+#     <code>self.image</code> is infinite.
 # *   #numerator: Returns the numerator of `self`.
-# *   #polar: Returns the array `[self.abs, self.arg]`.
+# *   #polar: Returns the array <code>[self.abs, self.arg]</code>.
 # *   #inspect: Returns a string representation of `self`.
 # *   #real: Returns the real value for `self`.
 # *   #real?: Returns `false`; for compatibility with Numeric#real?.
-# *   #rect (and its alias #rectangular): Returns the array `[self.real,
-#     self.imag]`.
+# *   #rect (and its alias #rectangular): Returns the array <code>[self.real,
+#     self.imag]</code>.
 #
 # ### Comparing
 #
@@ -100,12 +102,15 @@
 # ### Converting
 #
 # *   #rationalize: Returns a Rational object whose value is exactly or
-#     approximately equivalent to that of `self.real`.
+#     approximately equivalent to that of <code>self.real</code>.
 # *   #to_c: Returns `self`.
 # *   #to_d: Returns the value as a BigDecimal object.
-# *   #to_f: Returns the value of `self.real` as a Float, if possible.
-# *   #to_i: Returns the value of `self.real` as an Integer, if possible.
-# *   #to_r: Returns the value of `self.real` as a Rational, if possible.
+# *   #to_f: Returns the value of <code>self.real</code> as a Float, if
+#     possible.
+# *   #to_i: Returns the value of <code>self.real</code> as an Integer, if
+#     possible.
+# *   #to_r: Returns the value of <code>self.real</code> as a Rational, if
+#     possible.
 # *   #to_s: Returns a string representation of `self`.
 #
 # ### Performing Complex Arithmetic
@@ -118,7 +123,8 @@
 # *   #/: Returns the quotient of `self` and the given numeric.
 # *   #abs2: Returns square of the absolute value (magnitude) for `self`.
 # *   #conj (and its alias #conjugate): Returns the conjugate of `self`.
-# *   #fdiv: Returns `Complex.rect(self.real/numeric, self.imag/numeric)`.
+# *   #fdiv: Returns <code>Complex.rect(self.real/numeric,
+#     self.imag/numeric)</code>.
 #
 # ### Working with JSON
 #
@@ -283,10 +289,11 @@ class Complex < Numeric
   #
   # Returns:
   #
-  # *   `self.real <=> other.real` if both of the following are true:
+  # *   <code>self.real <=> other.real</code> if both of the following are true:
   #
-  #     *   `self.imag == 0`.
-  #     *   `other.imag == 0` (always true if `other` is numeric but not complex).
+  #     *   <code>self.imag == 0</code>.
+  #     *   <code>other.imag == 0</code> (always true if `other` is numeric but
+  #         not complex).
   #
   # *   `nil` otherwise.
   #
@@ -308,7 +315,8 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - complex == object -> true or false
   # -->
-  # Returns `true` if `self.real == object.real` and `self.imag == object.imag`:
+  # Returns `true` if <code>self.real == object.real</code> and <code>self.imag ==
+  # object.imag</code>:
   #
   #     Complex.rect(2, 3)  == Complex.rect(2.0, 3.0) # => true
   #
@@ -388,7 +396,8 @@ class Complex < Numeric
   def coerce: (Numeric) -> [ Complex, Complex ]
 
   # <!-- rdoc-file=complex.c -->
-  # Returns the conjugate of `self`, `Complex.rect(self.imag, self.real)`:
+  # Returns the conjugate of `self`, <code>Complex.rect(self.imag,
+  # self.real)</code>:
   #
   #     Complex.rect(1, 2).conj # => (1-2i)
   #
@@ -398,7 +407,8 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - conj -> complex
   # -->
-  # Returns the conjugate of `self`, `Complex.rect(self.imag, self.real)`:
+  # Returns the conjugate of `self`, <code>Complex.rect(self.imag,
+  # self.real)</code>:
   #
   #     Complex.rect(1, 2).conj # => (1-2i)
   #
@@ -410,11 +420,11 @@ class Complex < Numeric
   # -->
   # Returns the denominator of `self`, which is the [least common
   # multiple](https://en.wikipedia.org/wiki/Least_common_multiple) of
-  # `self.real.denominator` and `self.imag.denominator`:
+  # <code>self.real.denominator</code> and <code>self.imag.denominator</code>:
   #
   #     Complex.rect(Rational(1, 2), Rational(2, 3)).denominator # => 6
   #
-  # Note that `n.denominator` of a non-rational numeric is `1`.
+  # Note that <code>n.denominator</code> of a non-rational numeric is `1`.
   #
   # Related: Complex#numerator.
   #
@@ -428,7 +438,7 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - fdiv(numeric) -> new_complex
   # -->
-  # Returns `Complex.rect(self.real/numeric, self.imag/numeric)`:
+  # Returns <code>Complex.rect(self.real/numeric, self.imag/numeric)</code>:
   #
   #     Complex.rect(11, 22).fdiv(3) # => (3.6666666666666665+7.333333333333333i)
   #
@@ -438,8 +448,8 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - finite? -> true or false
   # -->
-  # Returns `true` if both `self.real.finite?` and `self.imag.finite?` are true,
-  # `false` otherwise:
+  # Returns `true` if both <code>self.real.finite?</code> and
+  # <code>self.imag.finite?</code> are true, `false` otherwise:
   #
   #     Complex.rect(1, 1).finite?               # => true
   #     Complex.rect(Float::INFINITY, 0).finite? # => false
@@ -467,7 +477,7 @@ class Complex < Numeric
   #   rdoc-file=numeric.c
   #   - i -> complex
   # -->
-  # Returns `Complex(0, self)`:
+  # Returns <code>Complex(0, self)</code>:
   #
   #     2.i              # => (0+2i)
   #     -2.i             # => (0-2i)
@@ -513,8 +523,8 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - infinite? -> 1 or nil
   # -->
-  # Returns `1` if either `self.real.infinite?` or `self.imag.infinite?` is true,
-  # `nil` otherwise:
+  # Returns `1` if either <code>self.real.infinite?</code> or
+  # <code>self.imag.infinite?</code> is true, `nil` otherwise:
   #
   #     Complex.rect(Float::INFINITY, 0).infinite? # => 1
   #     Complex.rect(1, 1).infinite?               # => nil
@@ -570,7 +580,7 @@ class Complex < Numeric
   # In this example, the lowest common denominator of the two parts is 12; the two
   # converted parts may be thought of as Rational(8, 12) and Rational(9, 12),
   # whose numerators, respectively, are 8 and 9; so the returned value of
-  # `c.numerator` is `Complex.rect(8, 9)`.
+  # <code>c.numerator</code> is <code>Complex.rect(8, 9)</code>.
   #
   # Related: Complex#denominator.
   #
@@ -594,7 +604,7 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - polar -> array
   # -->
-  # Returns the array `[self.abs, self.arg]`:
+  # Returns the array <code>[self.abs, self.arg]</code>:
   #
   #     Complex.polar(1, 2).polar # => [1.0, 2.0]
   #
@@ -629,17 +639,18 @@ class Complex < Numeric
   #   - rationalize(epsilon = nil) -> rational
   # -->
   # Returns a Rational object whose value is exactly or approximately equivalent
-  # to that of `self.real`.
+  # to that of <code>self.real</code>.
   #
   # With no argument `epsilon` given, returns a Rational object whose value is
-  # exactly equal to that of `self.real.rationalize`:
+  # exactly equal to that of <code>self.real.rationalize</code>:
   #
   #     Complex.rect(1, 0).rationalize              # => (1/1)
   #     Complex.rect(1, Rational(0, 1)).rationalize # => (1/1)
   #     Complex.rect(3.14159, 0).rationalize        # => (314159/100000)
   #
   # With argument `epsilon` given, returns a Rational object whose value is
-  # exactly or approximately equal to that of `self.real` to the given precision:
+  # exactly or approximately equal to that of <code>self.real</code> to the given
+  # precision:
   #
   #     Complex.rect(3.14159, 0).rationalize(0.1)          # => (16/5)
   #     Complex.rect(3.14159, 0).rationalize(0.01)         # => (22/7)
@@ -700,7 +711,7 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - rect -> array
   # -->
-  # Returns the array `[self.real, self.imag]`:
+  # Returns the array <code>[self.real, self.imag]</code>:
   #
   #     Complex.rect(1, 2).rect # => [1, 2]
   #
@@ -734,13 +745,13 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - to_f -> float
   # -->
-  # Returns the value of `self.real` as a Float, if possible:
+  # Returns the value of <code>self.real</code> as a Float, if possible:
   #
   #     Complex.rect(1, 0).to_f              # => 1.0
   #     Complex.rect(1, Rational(0, 1)).to_f # => 1.0
   #
-  # Raises RangeError if `self.imag` is not exactly zero (either `Integer(0)` or
-  # `Rational(0, *n*)`).
+  # Raises RangeError if <code>self.imag</code> is not exactly zero (either
+  # <code>Integer(0)</code> or <code>Rational(0, _n_)</code>).
   #
   def to_f: () -> Float
 
@@ -748,13 +759,13 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - to_i -> integer
   # -->
-  # Returns the value of `self.real` as an Integer, if possible:
+  # Returns the value of <code>self.real</code> as an Integer, if possible:
   #
   #     Complex.rect(1, 0).to_i              # => 1
   #     Complex.rect(1, Rational(0, 1)).to_i # => 1
   #
-  # Raises RangeError if `self.imag` is not exactly zero (either `Integer(0)` or
-  # `Rational(0, *n*)`).
+  # Raises RangeError if <code>self.imag</code> is not exactly zero (either
+  # <code>Integer(0)</code> or <code>Rational(0, _n_)</code>).
   #
   def to_i: () -> Integer
 
@@ -762,14 +773,15 @@ class Complex < Numeric
   #   rdoc-file=complex.c
   #   - to_r -> rational
   # -->
-  # Returns the value of `self.real` as a Rational, if possible:
+  # Returns the value of <code>self.real</code> as a Rational, if possible:
   #
   #     Complex.rect(1, 0).to_r              # => (1/1)
   #     Complex.rect(1, Rational(0, 1)).to_r # => (1/1)
   #     Complex.rect(1, 0.0).to_r            # => (1/1)
   #
-  # Raises RangeError if `self.imag` is not exactly zero (either `Integer(0)` or
-  # `Rational(0, *n*)`) and `self.imag.to_r` is not exactly zero.
+  # Raises RangeError if <code>self.imag</code> is not exactly zero (either
+  # <code>Integer(0)</code> or <code>Rational(0, _n_)</code>) and
+  # <code>self.imag.to_r</code> is not exactly zero.
   #
   # Related: Complex#rationalize.
   #
@@ -793,7 +805,7 @@ class Complex < Numeric
 end
 
 # <!-- rdoc-file=complex.c -->
-# Equivalent to `Complex.rect(0, 1)`:
+# Equivalent to <code>Complex.rect(0, 1)</code>:
 #
 #     Complex::I # => (0+1i)
 #