Update docs with rdoc-6.14.2 and ruby-3.4.5

Author: soutaro

.github/workflows/comments.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.4.1"
+          ruby-version: "3.4.5"
           bundler: none
       - name: Install dependencies
         run: |

core/io/wait.rbs

@@ -24,17 +24,22 @@ class IO
   # <!--
   #   rdoc-file=ext/io/wait/wait.c
   #   - io.wait(events, timeout) -> event mask, false or nil
-  #   - io.wait(timeout = nil, mode = :read) -> self, true, or false
+  #   - io.wait(*event_symbols[, timeout]) -> self, true, or false
   # -->
   # Waits until the IO becomes ready for the specified events and returns the
   # subset of events that become ready, or a falsy value when times out.
   #
   # The events can be a bit mask of `IO::READABLE`, `IO::WRITABLE` or
   # `IO::PRIORITY`.
   #
-  # Returns a truthy value immediately when buffered data is available.
+  # Returns an event mask (truthy value) immediately when buffered data is
+  # available.
   #
-  # Optional parameter `mode` is one of `:read`, `:write`, or `:read_write`.
+  # The second form: if one or more event symbols (`:read`, `:write`, or
+  # `:read_write`) are passed, the event mask is the bit OR of the bitmask
+  # corresponding to those symbols.  In this form, `timeout` is optional, the
+  # order of the arguments is arbitrary, and returns `io` if any of the events is
+  # ready.
   #
   # You must require 'io/wait' to use this method.
   #

core/kernel.rbs

@@ -1814,10 +1814,10 @@ module Kernel : BasicObject
   #      and returns a `true` or `false`;
   #      returns `false` if either entity does not exist:
   #  Character  |Test
-  # ------------|---------------------------------------------------------------
-  # <tt>'<'</tt>|Whether the `mtime` at `path0` is less than that at `path1`.
-  # <tt>'='</tt>|Whether the `mtime` at `path0` is equal to that at `path1`.
-  # <tt>'>'</tt>|Whether the `mtime` at `path0` is greater than that at `path1`.
+  # ------------|------------------------------------------------------------------------------------------------
+  # <tt>'<'</tt>|Whether the <code>mtime</code> at <code>path0</code> is less than that at <code>path1</code>.
+  # <tt>'='</tt>|Whether the <code>mtime</code> at <code>path0</code> is equal to that at <code>path1</code>.
+  # <tt>'>'</tt>|Whether the <code>mtime</code> at <code>path0</code> is greater than that at <code>path1</code>.
   # *   This test operates on the content of each of the entities at `path0` and
   #     `path1`,
   #      and returns a `true` or `false`;

core/ruby_vm.rbs

@@ -686,7 +686,7 @@ module RubyVM::YJIT
   #   - enable(stats: false, log: false)
   # -->
   # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats
-  # or not. `compilation_log` decides
+  # or not. `log` decides
   # whether to enable YJIT compilation logging or not.
   # *   `stats`:
   #     *   `false`: Don't enable stats.

core/rubygems/rubygems.rbs

@@ -1009,8 +1009,7 @@ module Gem
   #   - source_date_epoch_string()
   # -->
   # If the SOURCE_DATE_EPOCH environment variable is set, returns it's value.
-  # Otherwise, returns the time that `Gem.source_date_epoch_string` was first
-  # called in the same format as SOURCE_DATE_EPOCH.
+  # Otherwise, returns DEFAULT_SOURCE_DATE_EPOCH as a string.
   #
   # NOTE(@duckinator): The implementation is a tad weird because we want to:
   #     1. Make builds reproducible by default, by having this function always

core/time.rbs

@@ -984,10 +984,20 @@ class Time < Object
   #     now = Time.now
   #     # => 2022-08-18 10:24:13.5398485 -0500
   #     now.utc? # => false
+  #     now.getutc.utc? # => true
   #     utc = Time.utc(2000, 1, 1, 20, 15, 1)
   #     # => 2000-01-01 20:15:01 UTC
   #     utc.utc? # => true
   #
+  # `Time` objects created with these methods are considered to be in UTC:
+  #
+  # *   Time.utc
+  # *   Time#utc
+  # *   Time#getutc
+  #
+  # Objects created in other ways will not be treated as UTC even if the
+  # environment variable "TZ" is "UTC".
+  #
   # Related: Time.utc.
   #
   def gmt?: () -> bool
@@ -1560,10 +1570,20 @@ class Time < Object
   #     now = Time.now
   #     # => 2022-08-18 10:24:13.5398485 -0500
   #     now.utc? # => false
+  #     now.getutc.utc? # => true
   #     utc = Time.utc(2000, 1, 1, 20, 15, 1)
   #     # => 2000-01-01 20:15:01 UTC
   #     utc.utc? # => true
   #
+  # `Time` objects created with these methods are considered to be in UTC:
+  #
+  # *   Time.utc
+  # *   Time#utc
+  # *   Time#getutc
+  #
+  # Objects created in other ways will not be treated as UTC even if the
+  # environment variable "TZ" is "UTC".
+  #
   # Related: Time.utc.
   #
   def utc?: () -> bool

stdlib/rdoc/0/code_object.rbs

@@ -22,9 +22,10 @@ module RDoc
   #         *   RDoc::MetaMethod
   # *   RDoc::Alias
   # *   RDoc::Constant
+  # *   RDoc::Require
   # *   RDoc::Mixin
-  #     *   RDoc::Require
   #     *   RDoc::Include
+  #     *   RDoc::Extend
   #
   class CodeObject
     # <!-- rdoc-file=lib/rdoc/code_object.rb -->

stdlib/rdoc/0/parser.rbs

@@ -42,7 +42,7 @@ module RDoc
 
     # <!--
     #   rdoc-file=lib/rdoc/parser.rb
-    #   - new(top_level, file_name, content, options, stats)
+    #   - new(top_level, content, options, stats)
     # -->
     # Creates a new Parser storing `top_level`, `file_name`, `content`, `options`
     # and `stats` in instance variables.  In +@preprocess+ an

stdlib/rdoc/0/store.rbs

@@ -22,7 +22,7 @@ module RDoc
   class Store
     # <!--
     #   rdoc-file=lib/rdoc/store.rb
-    #   - new(path = nil, type = nil)
+    #   - new(options, path: nil, type: nil)
     # -->
     # Creates a new Store of `type` that will load or save to `path`
     #

stdlib/strscan/0/string_scanner.rbs

@@ -327,7 +327,7 @@
 #     Method     |          Return After Match           |Return After No Match
 # ---------------|---------------------------------------|---------------------
 #      #size     |     Count of captured substrings.     |       +nil+.
-#     #[](n)     |   <tt>n</tt>th captured substring.    |       +nil+.
+#     #{}[n]     |   <tt>n</tt>th captured substring.    |       +nil+.
 #    #captures   |   Array of all captured substrings.   |       +nil+.
 # #values_at(*n) |Array of specified captured substrings.|       +nil+.
 # #named_captures|        Hash of named captures.        |    <tt>{}</tt>.