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

data/core/float.rbs

@@ -12,7 +12,7 @@
 #
 # Others cannot; among these are the transcendental numbers, including:
 #
-# *   Pi, *π*: in mathematics, a number of infinite precision:
+# *   Pi, <em>π</em>: in mathematics, a number of infinite precision:
 #     3.1415926535897932384626433... (to 25 places); in Ruby, it is of limited
 #     precision (in this case, to 16 decimal places):
 #
@@ -32,8 +32,8 @@
 # Others do not:
 #
 # *   In mathematics, 2/3 as a decimal number is an infinitely-repeating
-#     decimal: 0.666... (forever); in Ruby, `2.0/3` is of limited precision (in
-#     this case, to 16 decimal places):
+#     decimal: 0.666... (forever); in Ruby, <code>2.0/3</code> is of limited
+#     precision (in this case, to 16 decimal places):
 #
 #         2.0/3 # => 0.6666666666666666
 #
@@ -139,7 +139,7 @@
 #
 # Others cannot; among these are the transcendental numbers, including:
 #
-# *   Pi, *π*: in mathematics, a number of infinite precision:
+# *   Pi, <em>π</em>: in mathematics, a number of infinite precision:
 #     3.1415926535897932384626433... (to 25 places); in Ruby, it is of limited
 #     precision (in this case, to 16 decimal places):
 #
@@ -159,8 +159,8 @@
 # Others do not:
 #
 # *   In mathematics, 2/3 as a decimal number is an infinitely-repeating
-#     decimal: 0.666... (forever); in Ruby, `2.0/3` is of limited precision (in
-#     this case, to 16 decimal places):
+#     decimal: 0.666... (forever); in Ruby, <code>2.0/3</code> is of limited
+#     precision (in this case, to 16 decimal places):
 #
 #         2.0/3 # => 0.6666666666666666
 #
@@ -390,7 +390,8 @@ class Float < Numeric
   #     2.0 < Rational(3, 1) # => true
   #     2.0 < 2.0            # => false
   #
-  # `Float::NAN < Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN < Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   def <: (Numeric) -> bool
 
@@ -407,7 +408,8 @@ class Float < Numeric
   #     2.0 <= 2.0            # => true
   #     2.0 <= 1.0            # => false
   #
-  # `Float::NAN <= Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN <= Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   def <=: (Numeric) -> bool
 
@@ -419,7 +421,7 @@ class Float < Numeric
   #
   # Returns:
   #
-  # *   `-1`, if `self` is less than `other`.
+  # *   <code>-1</code>, if `self` is less than `other`.
   # *   `0`, if `self` is equal to `other`.
   # *   `1`, if `self` is greater than `other`.
   # *   `nil`, if the two values are incommensurate.
@@ -434,7 +436,8 @@ class Float < Numeric
   #     2.0 <=> 1.9            # => 1
   #     2.0 <=> 'foo'          # => nil
   #
-  # `Float::NAN <=> Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN <=> Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   # Class Float includes module Comparable, each of whose methods uses Float#<=>
   # for comparison.
@@ -452,7 +455,8 @@ class Float < Numeric
   #     2.0 == Rational(2, 1) # => true
   #     2.0 == Complex(2, 0)  # => true
   #
-  # `Float::NAN == Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN == Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   # Related: Float#eql? (requires `other` to be a Float).
   #
@@ -466,7 +470,8 @@ class Float < Numeric
   #     2.0 == Rational(2, 1) # => true
   #     2.0 == Complex(2, 0)  # => true
   #
-  # `Float::NAN == Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN == Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   # Related: Float#eql? (requires `other` to be a Float).
   #
@@ -483,7 +488,8 @@ class Float < Numeric
   #     2.0 > Rational(1, 2) # => true
   #     2.0 > 2.0            # => false
   #
-  # `Float::NAN > Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN > Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   def >: (Numeric) -> bool
 
@@ -499,7 +505,8 @@ class Float < Numeric
   #     2.0 >= 2.0            # => true
   #     2.0 >= 2.1            # => false
   #
-  # `Float::NAN >= Float::NAN` returns an implementation-dependent value.
+  # <code>Float::NAN >= Float::NAN</code> returns an implementation-dependent
+  # value.
   #
   def >=: (Numeric) -> bool
 
@@ -554,7 +561,7 @@ class Float < Numeric
   #
   # When `ndigits` is non-positive,
   # returns an Integer based on a computed granularity:
-  # *   The granularity is `10 ** ndigits.abs`.
+  # *   The granularity is <code>10 ** ndigits.abs</code>.
   # *   The returned value is the largest multiple of the granularity
   #      that is less than or equal to `self`.
   # Examples with positive `self`:
@@ -620,7 +627,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - divmod(other) -> array
   # -->
-  # Returns a 2-element array `[q, r]`, where
+  # Returns a 2-element array <code>[q, r]</code>, where
   #
   #     q = (self/other).floor      # Quotient
   #     r = self % other            # Remainder
@@ -656,7 +663,8 @@ class Float < Numeric
   #     2.0.eql?(Rational(2, 1)) # => false
   #     2.0.eql?(Complex(2, 0))  # => false
   #
-  # `Float::NAN.eql?(Float::NAN)` returns an implementation-dependent value.
+  # <code>Float::NAN.eql?(Float::NAN)</code> returns an implementation-dependent
+  # value.
   #
   # Related: Float#== (performs type conversions).
   #
@@ -678,8 +686,8 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - finite? -> true or false
   # -->
-  # Returns `true` if `self` is not `Infinity`, `-Infinity`, or `NaN`, `false`
-  # otherwise:
+  # Returns `true` if `self` is not `Infinity`, <code>-Infinity</code>, or `NaN`,
+  # `false` otherwise:
   #
   #     f = 2.0      # => 2.0
   #     f.finite?    # => true
@@ -724,7 +732,7 @@ class Float < Numeric
   #
   # When `self` is non-zero and `ndigits` is non-positive,
   # returns an integer value based on a computed granularity:
-  # *   The granularity is `10 ** ndigits.abs`.
+  # *   The granularity is <code>10 ** ndigits.abs</code>.
   # *   The returned value is the largest multiple of the granularity
   #      that is less than or equal to `self`.
   # Examples with positive `self`:
@@ -772,7 +780,7 @@ class Float < Numeric
   # Returns:
   #
   # *   1, if `self` is `Infinity`.
-  # *   -1 if `self` is `-Infinity`.
+  # *   -1 if `self` is <code>-Infinity</code>.
   # *   `nil`, otherwise.
   #
   # Examples:
@@ -870,7 +878,7 @@ class Float < Numeric
   # Returns the next-larger representable Float.
   #
   # These examples show the internally stored values (64-bit hexadecimal) for each
-  # Float `f` and for the corresponding `f.next_float`:
+  # Float `f` and for the corresponding <code>f.next_float</code>:
   #
   #     f = 0.0      # 0x0000000000000000
   #     f.next_float # 0x0000000000000001
@@ -944,7 +952,7 @@ class Float < Numeric
   # Returns the next-smaller representable Float.
   #
   # These examples show the internally stored values (64-bit hexadecimal) for each
-  # Float `f` and for the corresponding `f.pev_float`:
+  # Float `f` and for the corresponding <code>f.pev_float</code>:
   #
   #     f = 5e-324   # 0x0000000000000001
   #     f.prev_float # 0x0000000000000000
@@ -1025,8 +1033,8 @@ class Float < Numeric
   #     f.round(1) # => -12345.7
   #     f.round(3) # => -12345.679
   #
-  # When `ndigits` is negative, returns an integer with at least `ndigits.abs`
-  # trailing zeros:
+  # When `ndigits` is negative, returns an integer with at least
+  # <code>ndigits.abs</code> trailing zeros:
   #
   #     f = 12345.6789
   #     f.round(0)  # => 12346
@@ -1038,19 +1046,20 @@ class Float < Numeric
   # If keyword argument `half` is given, and `self` is equidistant from the two
   # candidate values, the rounding is according to the given `half` value:
   #
-  # *   `:up` or `nil`: round away from zero:
+  # *   <code>:up</code> or `nil`: round away from zero:
   #
   #         2.5.round(half: :up)      # => 3
   #         3.5.round(half: :up)      # => 4
   #         (-2.5).round(half: :up)   # => -3
   #
-  # *   `:down`: round toward zero:
+  # *   <code>:down</code>: round toward zero:
   #
   #         2.5.round(half: :down)    # => 2
   #         3.5.round(half: :down)    # => 3
   #         (-2.5).round(half: :down) # => -2
   #
-  # *   `:even`: round toward the candidate whose last nonzero digit is even:
+  # *   <code>:even</code>: round toward the candidate whose last nonzero digit is
+  #     even:
   #
   #         2.5.round(half: :even)    # => 2
   #         3.5.round(half: :even)    # => 4
@@ -1163,8 +1172,8 @@ class Float < Numeric
   #     f.truncate(1) # => -12345.6
   #     f.truncate(3) # => -12345.678
   #
-  # When `ndigits` is negative, returns an integer with at least `ndigits.abs`
-  # trailing zeros:
+  # When `ndigits` is negative, returns an integer with at least
+  # <code>ndigits.abs</code> trailing zeros:
   #
   #     f = 12345.6789
   #     f.truncate(0)  # => 12345
@@ -1250,8 +1259,8 @@ Float::MAX_EXP: Integer
 # Usually defaults to 2.2250738585072014e-308.
 #
 # If the platform supports denormalized numbers, there are numbers between zero
-# and Float::MIN. `0.0.next_float` returns the smallest positive floating point
-# number including denormalized numbers.
+# and Float::MIN. <code>0.0.next_float</code> returns the smallest positive
+# floating point number including denormalized numbers.
 #
 Float::MIN: Float
 

data/core/gc.rbs

@@ -182,21 +182,21 @@ module GC
   #     GC.config(foo: 'bar')
   #     # => {rgengc_allow_full_mark: false, implementation: "default"}
   #
-  # **All-Implementations Configuration**
+  # <strong>All-Implementations Configuration</strong>
   #
   # The single read-only entry for all implementations is:
   #
-  # *   `:implementation`: the string name of the implementation; for the Ruby
-  #     default implementation, `'default'`.
+  # *   <code>:implementation</code>: the string name of the implementation; for
+  #     the Ruby default implementation, <code>'default'</code>.
   #
-  # **Implementation-Specific Configuration**
+  # <strong>Implementation-Specific Configuration</strong>
   #
   # A GC implementation maintains its own implementation-specific configuration.
   #
   # For Ruby's default implementation the single entry is:
   #
-  # *   `:rgengc_allow_full_mark`: Controls whether the GC is allowed to run a
-  #     full mark (young & old objects):
+  # *   <code>:rgengc_allow_full_mark</code>: Controls whether the GC is allowed
+  #     to run a full mark (young & old objects):
   #
   #     *   `true` (default): GC interleaves major and minor collections. A flag
   #         is set to notify GC that a full mark has been requested. This flag is
@@ -348,59 +348,66 @@ module GC
   #
   # The hash includes entries such as:
   #
-  # *   `:count`: The total number of garbage collections run since application
-  #     start (count includes both minor and major garbage collections).
-  # *   `:time`: The total time spent in garbage collections (in milliseconds).
-  # *   `:heap_allocated_pages`: The total number of allocated pages.
-  # *   `:heap_empty_pages`: The number of pages with no live objects, and that
-  #     could be released to the system.
-  # *   `:heap_sorted_length`: The number of pages that can fit into the buffer
-  #     that holds references to  all pages.
-  # *   `:heap_allocatable_pages`: The total number of pages the application could
-  #     allocate without additional GC.
-  # *   `:heap_available_slots`: The total number of slots in all
-  #     `:heap_allocated_pages`.
-  # *   `:heap_live_slots`: The total number of slots which contain live objects.
-  # *   `:heap_free_slots`: The total number of slots which do not contain live
-  #     objects.
-  # *   `:heap_final_slots`: The total number of slots with pending finalizers to
-  #     be run.
-  # *   `:heap_marked_slots`: The total number of objects marked in the last GC.
-  # *   `:heap_eden_pages`: The total number of pages which contain at least one
-  #     live slot.
-  # *   `:total_allocated_pages`: The cumulative number of pages allocated since
-  #     application start.
-  # *   `:total_freed_pages`: The cumulative number of pages freed since
-  #     application start.
-  # *   `:total_allocated_objects`: The cumulative number of objects allocated
+  # *   <code>:count</code>: The total number of garbage collections run since
+  #     application start (count includes both minor and major garbage
+  #     collections).
+  # *   <code>:time</code>: The total time spent in garbage collections (in
+  #     milliseconds).
+  # *   <code>:heap_allocated_pages</code>: The total number of allocated pages.
+  # *   <code>:heap_empty_pages</code>: The number of pages with no live objects,
+  #     and that could be released to the system.
+  # *   <code>:heap_sorted_length</code>: The number of pages that can fit into
+  #     the buffer that holds references to  all pages.
+  # *   <code>:heap_allocatable_pages</code>: The total number of pages the
+  #     application could allocate without additional GC.
+  # *   <code>:heap_available_slots</code>: The total number of slots in all
+  #     <code>:heap_allocated_pages</code>.
+  # *   <code>:heap_live_slots</code>: The total number of slots which contain
+  #     live objects.
+  # *   <code>:heap_free_slots</code>: The total number of slots which do not
+  #     contain live objects.
+  # *   <code>:heap_final_slots</code>: The total number of slots with pending
+  #     finalizers to be run.
+  # *   <code>:heap_marked_slots</code>: The total number of objects marked in the
+  #     last GC.
+  # *   <code>:heap_eden_pages</code>: The total number of pages which contain at
+  #     least one live slot.
+  # *   <code>:total_allocated_pages</code>: The cumulative number of pages
+  #     allocated since application start.
+  # *   <code>:total_freed_pages</code>: The cumulative number of pages freed
   #     since application start.
-  # *   `:total_freed_objects`: The cumulative number of objects freed since
-  #     application start.
-  # *   `:malloc_increase_bytes`: Amount of memory allocated on the heap for
-  #     objects. Decreased by any GC.
-  # *   `:malloc_increase_bytes_limit`: When `:malloc_increase_bytes` crosses this
-  #     limit, GC is triggered.
-  # *   `:minor_gc_count`: The total number of minor garbage collections run since
-  #     process start.
-  # *   `:major_gc_count`: The total number of major garbage collections run since
+  # *   <code>:total_allocated_objects</code>: The cumulative number of objects
+  #     allocated since application start.
+  # *   <code>:total_freed_objects</code>: The cumulative number of objects freed
+  #     since application start.
+  # *   <code>:malloc_increase_bytes</code>: Amount of memory allocated on the
+  #     heap for objects. Decreased by any GC.
+  # *   <code>:malloc_increase_bytes_limit</code>: When
+  #     <code>:malloc_increase_bytes</code> crosses this limit, GC is triggered.
+  # *   <code>:minor_gc_count</code>: The total number of minor garbage
+  #     collections run since process start.
+  # *   <code>:major_gc_count</code>: The total number of major garbage
+  #     collections run since process start.
+  # *   <code>:compact_count</code>: The total number of compactions run since
   #     process start.
-  # *   `:compact_count`: The total number of compactions run since process start.
-  # *   `:read_barrier_faults`: The total number of times the read barrier was
-  #     triggered during compaction.
-  # *   `:total_moved_objects`: The total number of objects compaction has moved.
-  # *   `:remembered_wb_unprotected_objects`: The total number of objects without
-  #     write barriers.
-  # *   `:remembered_wb_unprotected_objects_limit`: When
-  #     `:remembered_wb_unprotected_objects` crosses this limit, major GC is
-  #     triggered.
-  # *   `:old_objects`: Number of live, old objects which have survived at least 3
-  #     garbage collections.
-  # *   `:old_objects_limit`: When `:old_objects` crosses this limit, major GC is
+  # *   <code>:read_barrier_faults</code>: The total number of times the read
+  #     barrier was triggered during compaction.
+  # *   <code>:total_moved_objects</code>: The total number of objects compaction
+  #     has moved.
+  # *   <code>:remembered_wb_unprotected_objects</code>: The total number of
+  #     objects without write barriers.
+  # *   <code>:remembered_wb_unprotected_objects_limit</code>: When
+  #     <code>:remembered_wb_unprotected_objects</code> crosses this limit, major
+  #     GC is triggered.
+  # *   <code>:old_objects</code>: Number of live, old objects which have survived
+  #     at least 3 garbage collections.
+  # *   <code>:old_objects_limit</code>: When <code>:old_objects</code> crosses
+  #     this limit, major GC is triggered.
+  # *   <code>:oldmalloc_increase_bytes</code>: Amount of memory allocated on the
+  #     heap for objects. Decreased by major GC.
+  # *   <code>:oldmalloc_increase_bytes_limit</code>: When
+  #     <code>:oldmalloc_increase_bytes</code> crosses this limit, major GC is
   #     triggered.
-  # *   `:oldmalloc_increase_bytes`: Amount of memory allocated on the heap for
-  #     objects. Decreased by major GC.
-  # *   `:oldmalloc_increase_bytes_limit`: When `:oldmalloc_increase_bytes`
-  #     crosses this limit, major GC is triggered.
   #
   def self.stat: (?Hash[Symbol, untyped]? hash) -> Hash[Symbol, untyped]
                | (Symbol key) -> Integer
@@ -575,21 +582,22 @@ module GC
   #
   # The statistics for a heap may include:
   #
-  # *   `:slot_size`: The slot size of the heap in bytes.
-  # *   `:heap_allocatable_pages`: The number of pages that can be allocated
-  #     without triggering a new garbage collection cycle.
-  # *   `:heap_eden_pages`: The number of pages in the eden heap.
-  # *   `:heap_eden_slots`: The total number of slots in all of the pages in the
-  #     eden heap.
-  # *   `:total_allocated_pages`: The total number of pages that have been
-  #     allocated in the heap.
-  # *   `:total_freed_pages`: The total number of pages that have been freed and
-  #     released back to the system in the heap.
-  # *   `:force_major_gc_count`: The number of times this heap has forced major
-  #     garbage collection cycles to start due to running out of free slots.
-  # *   `:force_incremental_marking_finish_count`: The number of times this heap
-  #     has forced incremental marking to complete due to running out of pooled
+  # *   <code>:slot_size</code>: The slot size of the heap in bytes.
+  # *   <code>:heap_allocatable_pages</code>: The number of pages that can be
+  #     allocated without triggering a new garbage collection cycle.
+  # *   <code>:heap_eden_pages</code>: The number of pages in the eden heap.
+  # *   <code>:heap_eden_slots</code>: The total number of slots in all of the
+  #     pages in the eden heap.
+  # *   <code>:total_allocated_pages</code>: The total number of pages that have
+  #     been allocated in the heap.
+  # *   <code>:total_freed_pages</code>: The total number of pages that have been
+  #     freed and released back to the system in the heap.
+  # *   <code>:force_major_gc_count</code>: The number of times this heap has
+  #     forced major garbage collection cycles to start due to running out of free
   #     slots.
+  # *   <code>:force_incremental_marking_finish_count</code>: The number of times
+  #     this heap has forced incremental marking to complete due to running out of
+  #     pooled slots.
   #
   def self.stat_heap: (?Integer? heap_name, ?Hash[Symbol, untyped]? hash) -> Hash[Symbol, untyped]
                     | (Integer heap_name, Symbol key) -> Integer