rbs 3.0.0.dev.2 → 3.0.0.dev.3

data/core/file_test.rbs

@@ -6,34 +6,41 @@
 module FileTest
   # <!--
   #   rdoc-file=file.c
-  #   - File.blockdev?(file_name)   ->  true or false
+  #   - File.blockdev?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a block device.
+  # Returns `true` if `filepath` points to a block device, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.blockdev?('/dev/sda1')       # => true
+  #     File.blockdev?(File.new('t.tmp')) # => false
   #
   def self?.blockdev?: (String | IO file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.chardev?(file_name)   ->  true or false
+  #   - File.chardev?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a character device.
+  # Returns `true` if `filepath` points to a character device, `false` otherwise.
   #
-  # *file_name* can be an IO object.
+  #     File.chardev?($stdin)     # => true
+  #     File.chardev?('t.txt')     # => false
   #
   def self?.chardev?: (String | IO file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.directory?(file_name)   ->  true or false
+  #   - File.directory?(path) -> true or false
   # -->
-  # Returns `true` if the named file is a directory, or a symlink that points at a
-  # directory, and `false` otherwise.
+  # With string `object` given, returns `true` if `path` is a string path leading
+  # to a directory, or to a symbolic link to a directory; `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.directory?('.')              # => true
+  #     File.directory?('foo')            # => false
+  #     File.symlink('.', 'dirlink')      # => 0
+  #     File.directory?('dirlink')        # => true
+  #     File.symlink('t,txt', 'filelink') # => 0
+  #     File.directory?('filelink')       # => false
   #
-  #     File.directory?(".")
+  # Argument `path` can be an IO object.
   #
   def self?.directory?: (String | IO file_name) -> bool
 
@@ -145,11 +152,13 @@ module FileTest
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.pipe?(file_name)   ->  true or false
+  #   - File.pipe?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a pipe.
+  # Returns `true` if `filepath` points to a pipe, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.mkfifo('tmp/fifo')
+  #     File.pipe?('tmp/fifo') # => true
+  #     File.pipe?('t.txt')    # => false
   #
   def self?.pipe?: (String | IO file_name) -> bool
 
@@ -220,11 +229,13 @@ module FileTest
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.socket?(file_name)   ->  true or false
+  #   - File.socket?(filepath)   ->  true or false
   # -->
-  # Returns `true` if the named file is a socket.
+  # Returns `true` if `filepath` points to a socket, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     require 'socket'
+  #     File.socket?(Socket.new(:INET, :STREAM)) # => true
+  #     File.socket?(File.new('t.txt'))          # => false
   #
   def self?.socket?: (String | IO file_name) -> bool
 
@@ -240,9 +251,13 @@ module FileTest
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.symlink?(file_name)   ->  true or false
+  #   - File.symlink?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a symbolic link.
+  # Returns `true` if `filepath` points to a symbolic link, `false` otherwise:
+  #
+  #     symlink = File.symlink('t.txt', 'symlink')
+  #     File.symlink?('symlink') # => true
+  #     File.symlink?('t.txt')   # => false
   #
   def self?.symlink?: (String file_name) -> bool
 

data/core/float.rbs

@@ -13,127 +13,71 @@
 #
 # You can create a Float object explicitly with:
 #
-# *   A [floating-point
-#     literal](doc/syntax/literals_rdoc.html#label-Float+Literals).
+# *   A [floating-point literal](rdoc-ref:syntax/literals.rdoc@Float+Literals).
 #
 #
 # You can convert certain objects to Floats with:
 #
-# *   Method [Float](Kernel.html#method-i-Float).
+# *   Method #Float.
 #
 #
 # ## What's Here
 #
 # First, what's elsewhere. Class Float:
 #
-# *   Inherits from [class
-#     Numeric](Numeric.html#class-Numeric-label-What-27s+Here).
+# *   Inherits from [class Numeric](rdoc-ref:Numeric@What-27s+Here).
 #
 #
 # Here, class Float provides methods for:
 #
-# *   [Querying](#class-Float-label-Querying)
-# *   [Comparing](#class-Float-label-Comparing)
-# *   [Converting](#class-Float-label-Converting)
+# *   [Querying](rdoc-ref:Float@Querying)
+# *   [Comparing](rdoc-ref:Float@Comparing)
+# *   [Converting](rdoc-ref:Float@Converting)
 #
 #
 # ### Querying
 #
-#     #finite?
-# :       Returns whether `self` is finite.
-#
-#     #hash
-# :       Returns the integer hash code for `self`.
-#
-#     #infinite?
-# :       Returns whether `self` is infinite.
-#
-#     #nan?
-# :       Returns whether `self` is a NaN (not-a-number).
-#
+# *   #finite?: Returns whether `self` is finite.
+# *   #hash: Returns the integer hash code for `self`.
+# *   #infinite?: Returns whether `self` is infinite.
+# *   #nan?: Returns whether `self` is a NaN (not-a-number).
 #
 #
 # ### Comparing
 #
-#     [<](#method-i-3C)
-# :       Returns whether `self` is less than the given value.
-#
-#     [<=](#method-i-3C-3D)
-# :       Returns whether `self` is less than or equal to the given value.
-#
-#     [<=>](#method-i-3C-3D-3E)
-# :       Returns a number indicating whether `self` is less than, equal to, or
-#         greater than the given value.
-#
-#     [==](#method-i-3D-3D) (aliased as #=== and #eql>)
-# :       Returns whether `self` is equal to the given value.
-#
-#     [>](#method-i-3E)
-# :       Returns whether `self` is greater than the given value.
-#
-#     [>=](#method-i-3E-3D)
-# :       Returns whether `self` is greater than or equal to the given value.
-#
+# *   #<: Returns whether `self` is less than the given value.
+# *   #<=: Returns whether `self` is less than or equal to the given value.
+# *   #<=>: Returns a number indicating whether `self` is less than, equal to,
+#     or greater than the given value.
+# *   #== (aliased as #=== and #eql?): Returns whether `self` is equal to the
+#     given value.
+# *   #>: Returns whether `self` is greater than the given value.
+# *   #>=: Returns whether `self` is greater than or equal to the given value.
 #
 #
 # ### Converting
 #
-#     #% (aliased as #modulo)
-# :       Returns `self` modulo the given value.
-#
-#     #*
-# :       Returns the product of `self` and the given value.
-#
-#     [**](#method-i-2A-2A)
-# :       Returns the value of `self` raised to the power of the given value.
-#
-#     #+
-# :       Returns the sum of `self` and the given value.
-#
-#     #-
-# :       Returns the difference of `self` and the given value.
-#
-#     [/](#method-i-2F)
-# :       Returns the quotient of `self` and the given value.
-#
-#     #ceil
-# :       Returns the smallest number greater than or equal to `self`.
-#
-#     #coerce
-# :       Returns a 2-element array containing the given value converted to a
-#         Float and `self`
-#
-#     #divmod
-# :       Returns a 2-element array containing the quotient and remainder
-#         results of dividing `self` by the given value.
-#
-#     #fdiv
-# :       Returns the Float result of dividing `self` by the given value.
-#
-#     #floor
-# :       Returns the greatest number smaller than or equal to `self`.
-#
-#     #next_float
-# :       Returns the next-larger representable Float.
-#
-#     #prev_float
-# :       Returns the next-smaller representable Float.
-#
-#     #quo
-# :       Returns the quotient from dividing `self` by the given value.
-#
-#     #round
-# :       Returns `self` rounded to the nearest value, to a given precision.
-#
-#     #to_i (aliased as #to_int)
-# :       Returns `self` truncated to an Integer.
-#
-#     #to_s (aliased as #inspect)
-# :       Returns a string containing the place-value representation of `self`
-#         in the given radix.
-#
-#     #truncate
-# :       Returns `self` truncated to a given precision.
+# *   #% (aliased as #modulo): Returns `self` modulo the given value.
+# *   #*: Returns the product of `self` and the given value.
+# *   #**: Returns the value of `self` raised to the power of the given value.
+# *   #+: Returns the sum of `self` and the given value.
+# *   #-: Returns the difference of `self` and the given value.
+# *   #/: Returns the quotient of `self` and the given value.
+# *   #ceil: Returns the smallest number greater than or equal to `self`.
+# *   #coerce: Returns a 2-element array containing the given value converted to
+#     a Float and `self`
+# *   #divmod: Returns a 2-element array containing the quotient and remainder
+#     results of dividing `self` by the given value.
+# *   #fdiv: Returns the Float result of dividing `self` by the given value.
+# *   #floor: Returns the greatest number smaller than or equal to `self`.
+# *   #next_float: Returns the next-larger representable Float.
+# *   #prev_float: Returns the next-smaller representable Float.
+# *   #quo: Returns the quotient from dividing `self` by the given value.
+# *   #round: Returns `self` rounded to the nearest value, to a given precision.
+# *   #to_i (aliased as #to_int): Returns `self` truncated to an Integer.
+# *   #to_s (aliased as #inspect): Returns a string containing the place-value
+#     representation of `self` in the given radix.
+# *   #truncate: Returns `self` truncated to a given precision.
 #
 class Float < Numeric
   public
@@ -546,7 +490,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - finite? -> true or false
   # -->
-  # Returns `true` if `self` is not `Infinity`, `-Infinity`, or `Nan`, `false`
+  # Returns `true` if `self` is not `Infinity`, `-Infinity`, or `NaN`, `false`
   # otherwise:
   #
   #     f = 2.0      # => 2.0

data/core/gc.rbs

@@ -82,6 +82,8 @@ module GC
   # count
   # :   The total number of garbage collections ran 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 `:heap_eden_pages` + `:heap_tomb_pages`
   # heap_sorted_length
@@ -120,6 +122,12 @@ module GC
   # :   The total number of minor garbage collections run since process start
   # major_gc_count
   # :   The total number of major garbage collections 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
@@ -180,7 +188,7 @@ module GC
   def self.total_time: () -> Integer
 
   # <!--
-  #   rdoc-file=gc.rb
+  #   rdoc-file=gc.c
   #   - GC.compact
   # -->
   # This function compacts objects together in Ruby's heap.  It eliminates unused
@@ -192,6 +200,10 @@ module GC
   # This method is implementation specific and not expected to be implemented in
   # any implementation besides MRI.
   #
+  # To test whether GC compaction is supported, use the idiom:
+  #
+  #     GC.respond_to?(:compact)
+  #
   def self.compact: () -> ::Hash[:considered | :moved, Hash[Symbol | Integer, Integer]]
 
   # <!--
@@ -204,7 +216,7 @@ module GC
   # moved are replaced with T_MOVED objects.  No object should have a reference to
   # a T_MOVED object after compaction.
   #
-  # This function doubles the heap to ensure room to move all objects, compacts
+  # This function expands the heap to ensure room to move all objects, compacts
   # the heap to make sure everything moves, updates all references, then performs
   # a full GC.  If any object contains a reference to a T_MOVED object, that
   # object should be pushed on the mark stack, and will make a SEGV.
@@ -231,7 +243,7 @@ module GC
 
   # <!--
   #   rdoc-file=gc.rb
-  #   - GC.latest_gc_info -> {:gc_by=>:newobj}
+  #   - GC.latest_gc_info -> hash
   #   - GC.latest_gc_info(hash) -> hash
   #   - GC.latest_gc_info(:major_by) -> :malloc
   # -->