rbs 3.9.5 → 4.0.0

data/stdlib/uri/0/file.rbs

@@ -27,8 +27,8 @@ module URI
     # The components should be provided either as an Array, or as a Hash with keys
     # formed by preceding the component names with a colon.
     #
-    # If an Array is used, the components must be passed in the order `[host,
-    # path]`.
+    # If an Array is used, the components must be passed in the order <code>[host,
+    # path]</code>.
     #
     # A path from e.g. the File class should be escaped before being passed.
     #
@@ -43,7 +43,7 @@ module URI
     #       :path => '/ruby/src'})
     #     uri2.to_s  # => "file://host.example.com/ruby/src"
     #
-    #     uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
+    #     uri3 = URI::File.build({:path => URI::RFC2396_PARSER.escape('/path/my file.txt')})
     #     uri3.to_s  # => "file:///path/my%20file.txt"
     #
     def self.build: (Array[String] args) -> URI::File

data/stdlib/uri/0/generic.rbs

@@ -145,7 +145,7 @@ module URI
     #
     # At first, tries to create a new URI::Generic instance using
     # URI::Generic::build. But, if exception URI::InvalidComponentError is raised,
-    # then it does URI::Escape.escape all URI components and tries again.
+    # then it does URI::RFC2396_PARSER.escape all URI components and tries again.
     #
     def self.build2: (Array[nil | String | Integer]) -> URI::Generic
                    | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> instance
@@ -293,7 +293,7 @@ module URI
     # -->
     # Returns the parser to be used.
     #
-    # Unless a URI::Parser is defined, DEFAULT_PARSER is used.
+    # Unless the `parser` is defined, DEFAULT_PARSER is used.
     #
     def parser: () -> untyped
 
@@ -317,7 +317,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_scheme(v)
     # -->
-    # Checks the scheme `v` component against the URI::Parser Regexp for :SCHEME.
+    # Checks the scheme `v` component against the `parser` Regexp for :SCHEME.
     #
     def check_scheme: (String? v) -> true
 
@@ -374,8 +374,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_user(v)
     # -->
-    # Checks the user `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :USERINFO.
+    # Checks the user `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :USERINFO.
     #
     # Can not have a registry or opaque component defined, with a user component
     # defined.
@@ -387,7 +387,7 @@ module URI
     #   - check_password(v, user = @user)
     # -->
     # Checks the password `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :USERINFO.
+    # `parser` Regexp for :USERINFO.
     #
     # Can not have a registry or opaque component defined, with a user component
     # defined.
@@ -424,7 +424,7 @@ module URI
     #
     #     uri = URI.parse("http://john:S3nsit1ve@my.example.com")
     #     uri.user = "sam"
-    #     uri.to_s  #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
+    #     uri.to_s  #=> "http://sam@my.example.com"
     #
     def user=: (String? user) -> String?
 
@@ -489,8 +489,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - split_userinfo(ui)
     # -->
-    # Returns the userinfo `ui` as `[user, password]` if properly formatted as
-    # 'user:password'.
+    # Returns the userinfo `ui` as <code>[user, password]</code> if properly
+    # formatted as 'user:password'.
     #
     def split_userinfo: (String ui) -> Array[String | nil]
 
@@ -530,8 +530,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_host(v)
     # -->
-    # Checks the host `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :HOST.
+    # Checks the host `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :HOST.
     #
     # Can not have a registry or opaque component defined, with a host component
     # defined.
@@ -611,8 +611,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_port(v)
     # -->
-    # Checks the port `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :PORT.
+    # Checks the port `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :PORT.
     #
     # Can not have a registry or opaque component defined, with a port component
     # defined.
@@ -670,8 +670,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_path(v)
     # -->
-    # Checks the path `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :ABS_PATH and :REL_PATH.
+    # Checks the path `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :ABS_PATH and :REL_PATH.
     #
     # Can not have a opaque component defined, with a path component defined.
     #
@@ -742,7 +742,7 @@ module URI
     #   - check_opaque(v)
     # -->
     # Checks the opaque `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :OPAQUE.
+    # `parser` Regexp for :OPAQUE.
     #
     # Can not have a host, port, user, or path component defined, with an opaque
     # component defined.
@@ -781,8 +781,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - fragment=(v)
     # -->
-    # Checks the fragment `v` component against the URI::Parser Regexp for
-    # :FRAGMENT.
+    # Checks the fragment `v` component against the `parser` Regexp for :FRAGMENT.
     #
     # ## Args
     #
@@ -910,6 +909,13 @@ module URI
     #
     def merge: (URI::Generic | string oth) -> URI::Generic
 
+    # <!--
+    #   rdoc-file=lib/uri/generic.rb
+    #   - +(oth)
+    # -->
+    #
+    alias + merge
+
     # :stopdoc:
     def route_from_path: (String src, String dst) -> String
 
@@ -1010,6 +1016,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - hash()
     # -->
+    # Returns the hash value.
     #
     def hash: () -> Integer
 
@@ -1017,6 +1024,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - eql?(oth)
     # -->
+    # Compares with *oth* for Hash.
     #
     def eql?: (URI::Generic oth) -> bool
 

data/stdlib/uri/0/http.rbs

@@ -32,8 +32,8 @@ module URI
     # The components should be provided either as an Array, or as a Hash with keys
     # formed by preceding the component names with a colon.
     #
-    # If an Array is used, the components must be passed in the order `[userinfo,
-    # host, port, path, query, fragment]`.
+    # If an Array is used, the components must be passed in the order
+    # <code>[userinfo, host, port, path, query, fragment]</code>.
     #
     # Example:
     #

data/stdlib/uri/0/ldap.rbs

@@ -38,8 +38,8 @@ module URI
     # The components should be provided either as an Array, or as a Hash with keys
     # formed by preceding the component names with a colon.
     #
-    # If an Array is used, the components must be passed in the order `[host, port,
-    # dn, attributes, scope, filter, extensions]`.
+    # If an Array is used, the components must be passed in the order <code>[host,
+    # port, dn, attributes, scope, filter, extensions]</code>.
     #
     # Example:
     #

data/stdlib/uri/0/mailto.rbs

@@ -15,13 +15,13 @@ module URI
     # Creates a new URI::MailTo object from components, with syntax checking.
     #
     # Components can be provided as an Array or Hash. If an Array is used, the
-    # components must be supplied as `[to, headers]`.
+    # components must be supplied as <code>[to, headers]</code>.
     #
     # If a Hash is used, the keys are the component names preceded by colons.
     #
     # The headers can be supplied as a pre-encoded string, such as
-    # `"subject=subscribe&cc=address"`, or as an Array of Arrays like `[['subject',
-    # 'subscribe'], ['cc', 'address']]`.
+    # <code>"subject=subscribe&cc=address"</code>, or as an Array of Arrays like
+    # <code>[['subject', 'subscribe'], ['cc', 'address']]</code>.
     #
     # Examples:
     #

data/stdlib/uri/0/rfc2396_parser.rbs

@@ -17,14 +17,14 @@ module URI
     # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
     # The Hash of patterns.
     #
-    # See also URI::Parser.initialize_pattern.
+    # See also #initialize_pattern.
     #
     attr_reader pattern: Hash[Symbol, String]
 
     # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
     # The Hash of Regexp.
     #
-    # See also URI::Parser.initialize_regexp.
+    # See also #initialize_regexp.
     #
     attr_reader regexp: Hash[Symbol, Regexp]
 
@@ -34,7 +34,7 @@ module URI
     # -->
     # ## Synopsis
     #
-    #     URI::Parser.new([opts])
+    #     URI::RFC2396_Parser.new([opts])
     #
     # ## Args
     #
@@ -52,7 +52,7 @@ module URI
     #
     # ## Examples
     #
-    #     p = URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
+    #     p = URI::RFC2396_Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
     #     u = p.parse("http://example.jp/%uABCD") #=> #<URI::HTTP http://example.jp/%uABCD>
     #     URI.parse(u.to_s) #=> raises URI::InvalidURIError
     #
@@ -75,7 +75,7 @@ module URI
     # :   String to make safe
     #
     # `unsafe`
-    # :   Regexp to apply. Defaults to `self.regexp[:UNSAFE]`
+    # :   Regexp to apply. Defaults to <code>self.regexp[:UNSAFE]</code>
     #
     #
     # ## Description
@@ -105,7 +105,7 @@ module URI
     # Attempts to parse and merge a set of URIs. If no `block` given, then returns
     # the result, else it calls `block` for each element in result.
     #
-    # See also URI::Parser.make_regexp.
+    # See also #make_regexp.
     #
     def extract: (String str, ?Array[String] schemes) -> Array[String]
                | (String str, ?Array[String] schemes) { (String) -> untyped } -> nil
@@ -130,8 +130,9 @@ module URI
     #   rdoc-file=lib/uri/rfc2396_parser.rb
     #   - make_regexp(schemes = nil)
     # -->
-    # Returns Regexp that is default `self.regexp[:ABS_URI_REF]`, unless `schemes`
-    # is provided. Then it is a Regexp.union with `self.pattern[:X_ABS_URI]`.
+    # Returns Regexp that is default <code>self.regexp[:ABS_URI_REF]</code>, unless
+    # `schemes` is provided. Then it is a Regexp.union with
+    # <code>self.pattern[:X_ABS_URI]</code>.
     #
     def make_regexp: (?Array[String] schemes) -> Regexp
 
@@ -152,8 +153,7 @@ module URI
     #
     # ## Usage
     #
-    #     p = URI::Parser.new
-    #     p.parse("ldap://ldap.example.com/dc=example?user=john")
+    #     URI::RFC2396_PARSER.parse("ldap://ldap.example.com/dc=example?user=john")
     #     #=> #<URI::LDAP ldap://ldap.example.com/dc=example?user=john>
     #
     def parse: (String uri) -> URI::Generic
@@ -162,7 +162,7 @@ module URI
     #   rdoc-file=lib/uri/rfc2396_parser.rb
     #   - split(uri)
     # -->
-    # Returns a split URI against `regexp[:ABS_URI]`.
+    # Returns a split URI against <code>regexp[:ABS_URI]</code>.
     #
     def split: (String uri) -> [ String?, String?, String?, String?, String?, String?, String?, String?, String? ]
 
@@ -177,7 +177,7 @@ module URI
     # :   String to remove escapes from
     #
     # `escaped`
-    # :   Regexp to apply. Defaults to `self.regexp[:ESCAPED]`
+    # :   Regexp to apply. Defaults to <code>self.regexp[:ESCAPED]</code>
     #
     #
     # ## Description

data/stdlib/zlib/0/deflate.rbs

@@ -78,9 +78,10 @@ module Zlib
     #   - flush(flush = Zlib::SYNC_FLUSH)                 -> String
     #   - flush(flush = Zlib::SYNC_FLUSH) { |chunk| ... } -> nil
     # -->
-    # This method is equivalent to `deflate('', flush)`. This method is just
-    # provided to improve the readability of your Ruby program.  If a block is given
-    # chunks of deflate output are yielded to the block until the buffer is flushed.
+    # This method is equivalent to <code>deflate('', flush)</code>. This method is
+    # just provided to improve the readability of your Ruby program.  If a block is
+    # given chunks of deflate output are yielded to the block until the buffer is
+    # flushed.
     #
     # See Zlib::Deflate#deflate for detail on the `flush` constants NO_FLUSH,
     # SYNC_FLUSH, FULL_FLUSH and FINISH.

data/stdlib/zlib/0/gzip_reader.rbs

@@ -35,8 +35,8 @@ module Zlib
   # Be careful of the footer of the gzip file. A gzip file has the checksum of
   # pre-compressed data in its footer. GzipReader checks all uncompressed data
   # against that checksum at the following cases, and if it fails, raises
-  # `Zlib::GzipFile::NoFooter`, `Zlib::GzipFile::CRCError`, or
-  # `Zlib::GzipFile::LengthError` exception.
+  # <code>Zlib::GzipFile::NoFooter</code>, <code>Zlib::GzipFile::CRCError</code>,
+  # or <code>Zlib::GzipFile::LengthError</code> exception.
   #
   # *   When an reading request is received beyond the end of file (the end of
   #     compressed data). That is, when Zlib::GzipReader#read,
@@ -62,8 +62,8 @@ module Zlib
     # GzipReader object associated with that file.  Further details of this method
     # are in Zlib::GzipReader.new and ZLib::GzipFile.wrap.
     #
-    def self.open: (String | _ToPath filename) -> instance
-                 | (String | _ToPath filename) { (instance gz) -> void } -> void
+    def self.open: (path filename) -> instance
+                 | (path filename) { (instance gz) -> void } -> void
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c
@@ -282,8 +282,8 @@ module Zlib
     # `read` method that behaves same as the IO#read.
     #
     # The `options` hash may be used to set the encoding of the data.
-    # `:external_encoding`, `:internal_encoding` and `:encoding` may be set as in
-    # IO::new.
+    # <code>:external_encoding</code>, <code>:internal_encoding</code> and
+    # <code>:encoding</code> may be set as in IO::new.
     #
     # If the gzip file header is incorrect, raises an Zlib::GzipFile::Error
     # exception.

data/stdlib/zlib/0/gzip_writer.rbs

@@ -38,7 +38,8 @@ module Zlib
     # returns a GzipWriter object associated with that file.  Further details of
     # this method are found in Zlib::GzipWriter.new and Zlib::GzipFile.wrap.
     #
-    def self.open: (String filename) { (instance gz) -> void } -> instance
+    def self.open: (String filename, ?Integer level, ?Integer strategy, **untyped opts) -> instance
+                 | (String filename, ?Integer level, ?Integer strategy, **untyped opts) { (instance gz) -> void } -> nil
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c
@@ -61,10 +62,11 @@ module Zlib
     #   - flush(flush=nil)
     # -->
     # Flushes all the internal buffers of the GzipWriter object.  The meaning of
-    # `flush` is same as in Zlib::Deflate#deflate.  `Zlib::SYNC_FLUSH` is used if
-    # `flush` is omitted.  It is no use giving flush `Zlib::NO_FLUSH`.
+    # `flush` is same as in Zlib::Deflate#deflate.  <code>Zlib::SYNC_FLUSH</code> is
+    # used if `flush` is omitted.  It is no use giving flush
+    # <code>Zlib::NO_FLUSH</code>.
     #
-    def flush: (?Integer flush) -> String
+    def flush: (?Integer flush) -> self
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c
@@ -74,16 +76,16 @@ module Zlib
     #
     # Setting the mtime in the gzip header does not effect the mtime of the file
     # generated. Different utilities that expand the gzipped files may use the mtime
-    # header. For example the gunzip utility can use the `-N` flag which will set
-    # the resultant file's mtime to the value in the header. By default many tools
-    # will set the mtime of the expanded file to the mtime of the gzipped file, not
-    # the mtime in the header.
+    # header. For example the gunzip utility can use the <code>-N</code> flag which
+    # will set the resultant file's mtime to the value in the header. By default
+    # many tools will set the mtime of the expanded file to the mtime of the gzipped
+    # file, not the mtime in the header.
     #
     # If you do not set an mtime, the default value will be the time when
     # compression started. Setting a value of 0 indicates no time stamp is
     # available.
     #
-    def mtime=: (string | _ToPath | IO file_name) -> Time
+    def mtime=: (Time | Integer) -> void
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c
@@ -158,9 +160,9 @@ module Zlib
     # that behaves the same as IO#write.
     #
     # The `options` hash may be used to set the encoding of the data.
-    # `:external_encoding`, `:internal_encoding` and `:encoding` may be set as in
-    # IO::new.
+    # <code>:external_encoding</code>, <code>:internal_encoding</code> and
+    # <code>:encoding</code> may be set as in IO::new.
     #
-    def initialize: (_Writer io, Integer level, Integer strategy, **untyped opts) -> void
+    def initialize: (_Writer io, ?Integer? level, ?Integer? strategy, **untyped opts) -> void
   end
 end

data/stdlib/zlib/0/inflate.rbs

@@ -123,7 +123,7 @@ module Zlib
     #
     #     What is this?
     #
-    # `:)`
+    # <code>:)</code>
     #
     def sync_point?: () -> bool
 

data/stdlib/zlib/0/need_dict.rbs

@@ -6,7 +6,7 @@ module Zlib
   # When zlib returns a Z_NEED_DICT if a preset dictionary is needed at this
   # point.
   #
-  # Used by Zlib::Inflate.inflate and `Zlib.inflate`
+  # Used by Zlib::Inflate.inflate and <code>Zlib.inflate</code>
   #
   class NeedDict < Zlib::Error
   end

data/stdlib/zlib/0/zstream.rbs

@@ -153,6 +153,7 @@ module Zlib
     #   rdoc-file=ext/zlib/zlib.c
     #   - flush_next_in -> input
     # -->
+    # Flushes input buffer and returns all data in that buffer.
     #
     def flush_next_in: () -> String