Skip to content

Commit b677b05

Browse files
committed
Run bin/generate_docs.sh again
1 parent 729f3bc commit b677b05

File tree

5 files changed

+37
-5
lines changed

5 files changed

+37
-5
lines changed

core/io/wait.rbs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,22 @@ class IO
33
# <!--
44
# rdoc-file=io.c
55
# - io.wait(events, timeout) -> event mask, false or nil
6-
# - io.wait(timeout = nil, mode = :read) -> self, true, or false
6+
# - io.wait(*event_symbols[, timeout]) -> self, true, or false
77
# -->
88
# Waits until the IO becomes ready for the specified events and returns the
99
# subset of events that become ready, or a falsy value when times out.
1010
#
1111
# The events can be a bit mask of `IO::READABLE`, `IO::WRITABLE` or
1212
# `IO::PRIORITY`.
1313
#
14-
# Returns a truthy value immediately when buffered data is available.
14+
# Returns an event mask (truthy value) immediately when buffered data is
15+
# available.
1516
#
16-
# Optional parameter `mode` is one of `:read`, `:write`, or `:read_write`.
17+
# The second form: if one or more event symbols (`:read`, `:write`, or
18+
# `:read_write`) are passed, the event mask is the bit OR of the bitmask
19+
# corresponding to those symbols. In this form, `timeout` is optional, the
20+
# order of the arguments is arbitrary, and returns `io` if any of the events is
21+
# ready.
1722
#
1823
def wait: (Integer events, ?Time::_Timeout timeout) -> (Integer | false | nil)
1924
| (?Time::_Timeout? timeout, *wait_mode mode) -> (self | true | false)

core/rubygems/rubygems.rbs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -942,8 +942,7 @@ module Gem
942942
# - source_date_epoch_string()
943943
# -->
944944
# If the SOURCE_DATE_EPOCH environment variable is set, returns it's value.
945-
# Otherwise, returns the time that `Gem.source_date_epoch_string` was first
946-
# called in the same format as SOURCE_DATE_EPOCH.
945+
# Otherwise, returns DEFAULT_SOURCE_DATE_EPOCH as a string.
947946
#
948947
# NOTE(@duckinator): The implementation is a tad weird because we want to:
949948
# 1. Make builds reproducible by default, by having this function always

core/time.rbs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -990,10 +990,20 @@ class Time < Object
990990
# now = Time.now
991991
# # => 2022-08-18 10:24:13.5398485 -0500
992992
# now.utc? # => false
993+
# now.getutc.utc? # => true
993994
# utc = Time.utc(2000, 1, 1, 20, 15, 1)
994995
# # => 2000-01-01 20:15:01 UTC
995996
# utc.utc? # => true
996997
#
998+
# `Time` objects created with these methods are considered to be in UTC:
999+
#
1000+
# * Time.utc
1001+
# * Time#utc
1002+
# * Time#getutc
1003+
#
1004+
# Objects created in other ways will not be treated as UTC even if the
1005+
# environment variable "TZ" is "UTC".
1006+
#
9971007
# Related: Time.utc.
9981008
#
9991009
def gmt?: () -> bool
@@ -1566,10 +1576,20 @@ class Time < Object
15661576
# now = Time.now
15671577
# # => 2022-08-18 10:24:13.5398485 -0500
15681578
# now.utc? # => false
1579+
# now.getutc.utc? # => true
15691580
# utc = Time.utc(2000, 1, 1, 20, 15, 1)
15701581
# # => 2000-01-01 20:15:01 UTC
15711582
# utc.utc? # => true
15721583
#
1584+
# `Time` objects created with these methods are considered to be in UTC:
1585+
#
1586+
# * Time.utc
1587+
# * Time#utc
1588+
# * Time#getutc
1589+
#
1590+
# Objects created in other ways will not be treated as UTC even if the
1591+
# environment variable "TZ" is "UTC".
1592+
#
15731593
# Related: Time.utc.
15741594
#
15751595
def utc?: () -> bool

stdlib/uri/0/common.rbs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,9 @@ URI::ABS_URI: Regexp
535535

536536
URI::ABS_URI_REF: Regexp
537537

538+
# <!-- rdoc-file=lib/uri/common.rb -->
539+
# The default parser instance.
540+
#
538541
URI::DEFAULT_PARSER: URI::RFC2396_Parser
539542

540543
URI::ESCAPED: Regexp
@@ -557,6 +560,9 @@ URI::REL_URI: Regexp
557560

558561
URI::REL_URI_REF: Regexp
559562

563+
# <!-- rdoc-file=lib/uri/common.rb -->
564+
# The default parser instance for RFC 3986.
565+
#
560566
URI::RFC3986_PARSER: URI::RFC3986_Parser
561567

562568
URI::SCHEME: Regexp

stdlib/uri/0/generic.rbs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,13 +1009,15 @@ module URI
10091009
# rdoc-file=lib/uri/generic.rb
10101010
# - hash()
10111011
# -->
1012+
# Returns the hash value.
10121013
#
10131014
def hash: () -> Integer
10141015

10151016
# <!--
10161017
# rdoc-file=lib/uri/generic.rb
10171018
# - eql?(oth)
10181019
# -->
1020+
# Compares with *oth* for Hash.
10191021
#
10201022
def eql?: (URI::Generic oth) -> bool
10211023

0 commit comments

Comments
 (0)