rbs 4.0.0.dev.4 → 4.0.0

data/core/dir.rbs

@@ -116,10 +116,12 @@
 #
 # *   ::[]: Same as ::glob without the ability to pass flags.
 # *   ::children: Returns an array of names of the children (both files and
-#     directories) of the given directory, but not including `.` or `..`.
+#     directories) of the given directory, but not including <code>.</code> or
+#     <code>..</code>.
 # *   ::empty?: Returns whether the given path is an empty directory.
 # *   ::entries: Returns an array of names of the children (both files and
-#     directories) of the given directory, including `.` and `..`.
+#     directories) of the given directory, including <code>.</code> and
+#     <code>..</code>.
 # *   ::exist?: Returns whether the given path is a directory.
 # *   ::getwd (aliased as #pwd): Returns the path to the current working
 #     directory.
@@ -128,7 +130,8 @@
 # *   ::home: Returns the home directory path for a given user or the current
 #     user.
 # *   #children: Returns an array of names of the children (both files and
-#     directories) of `self`, but not including `.` or `..`.
+#     directories) of `self`, but not including <code>.</code> or
+#     <code>..</code>.
 # *   #fileno: Returns the integer file descriptor for `self`.
 # *   #path (aliased as #to_path): Returns the path used to create `self`.
 # *   #tell (aliased as #pos): Returns the integer position in the directory
@@ -137,13 +140,13 @@
 # ### Iterating
 #
 # *   ::each_child: Calls the given block with each entry in the given
-#     directory, but not including `.` or `..`.
+#     directory, but not including <code>.</code> or <code>..</code>.
 # *   ::foreach: Calls the given block with each entry in the given directory,
-#     including `.` and `..`.
-# *   #each: Calls the given block with each entry in `self`, including `.` and
-#     `..`.
+#     including <code>.</code> and <code>..</code>.
+# *   #each: Calls the given block with each entry in `self`, including
+#     <code>.</code> and <code>..</code>.
 # *   #each_child: Calls the given block with each entry in `self`, but not
-#     including `.` or `..`.
+#     including <code>.</code> or <code>..</code>.
 #
 # ### Other
 #
@@ -171,7 +174,7 @@ class Dir
   # system's encoding is used:
   #
   #     Dir.new('.').read.encoding                       # => #<Encoding:UTF-8>
-  #     Dir.new('.', encoding: 'US-ASCII').read.encoding # => #<Encoding:US-ASCII>
+  #     Dir.new('.', encoding: Encoding::US_ASCI).read.encoding # => #<Encoding:US-ASCII>
   #
   def initialize: (path dir, ?encoding: encoding?) -> void
 
@@ -255,7 +258,8 @@ class Dir
   #   - Dir.children(dirpath, encoding: 'UTF-8') -> array
   # -->
   # Returns an array of the entry names in the directory at `dirpath` except for
-  # `'.'` and `'..'`; sets the given encoding onto each returned entry name:
+  # <code>'.'</code> and <code>'..'</code>; sets the given encoding onto each
+  # returned entry name:
   #
   #     Dir.children('/example') # => ["config.h", "lib", "main.rb"]
   #     Dir.children('/example').first.encoding
@@ -274,8 +278,9 @@ class Dir
   #   - Dir.chroot(dirpath) -> 0
   # -->
   # Changes the root directory of the calling process to that specified in
-  # `dirpath`. The new root directory is used for pathnames beginning with `'/'`.
-  # The root directory is inherited by all children of the calling process.
+  # `dirpath`. The new root directory is used for pathnames beginning with
+  # <code>'/'</code>. The root directory is inherited by all children of the
+  # calling process.
   #
   # Only a privileged process may call `chroot`.
   #
@@ -300,7 +305,8 @@ class Dir
   #   - Dir.each_child(dirpath) {|entry_name| ... } -> nil
   #   - Dir.each_child(dirpath, encoding: 'UTF-8') {|entry_name| ... }  -> nil
   # -->
-  # Like Dir.foreach, except that entries `'.'` and `'..'` are not included.
+  # Like Dir.foreach, except that entries <code>'.'</code> and <code>'..'</code>
+  # are not included.
   #
   def self.each_child: (path dirname, ?encoding: encoding?) -> Enumerator[String, nil]
                      | (path dirname, ?encoding: encoding?) { (String filename) -> void } -> nil
@@ -477,8 +483,8 @@ class Dir
 
   # <!--
   #   rdoc-file=dir.rb
-  #   - Dir.glob(*patterns, flags: 0, base: nil, sort: true) -> array
-  #   - Dir.glob(*patterns, flags: 0, base: nil, sort: true) {|entry_name| ... } -> nil
+  #   - Dir.glob(patterns, flags: 0, base: nil, sort: true) -> array
+  #   - Dir.glob(patterns, flags: 0, base: nil, sort: true) {|entry_name| ... } -> nil
   # -->
   # Forms an array *entry_names* of the entry names selected by the arguments.
   #
@@ -487,8 +493,8 @@ class Dir
   #
   # Notes for the following examples:
   #
-  # *   `'*'` is the pattern that matches any entry name except those that begin
-  #     with `'.'`.
+  # *   <code>'*'</code> is the pattern that matches any entry name except those
+  #     that begin with <code>'.'</code>.
   # *   We use method Array#take to shorten returned arrays that otherwise would
   #     be very large.
   #
@@ -513,8 +519,8 @@ class Dir
   #
   # If optional keyword argument `base` is given, its value specifies the base
   # directory. Each pattern string specifies entries relative to the base
-  # directory; the default is `'.'`. The base directory is not prepended to the
-  # entry names in the result:
+  # directory; the default is <code>'.'</code>. The base directory is not
+  # prepended to the entry names in the result:
   #
   #     Dir.glob(pattern, base: 'lib').take(5)
   #     # => ["abbrev.gemspec", "abbrev.rb", "base64.gemspec", "base64.rb", "benchmark.gemspec"]
@@ -531,60 +537,64 @@ class Dir
   # Each pattern string is expanded according to certain metacharacters; examples
   # below use the [Ruby file tree](rdoc-ref:Dir@About+the+Examples):
   #
-  # *   `'*'`: Matches any substring in an entry name, similar in meaning to
-  #     regexp `/.*/mx`; may be restricted by other values in the pattern strings:
+  # *   <code>'*'</code>: Matches any substring in an entry name, similar in
+  #     meaning to regexp <code>/.*/mx</code>; may be restricted by other values
+  #     in the pattern strings:
   #
-  #     *   `'*'` matches all entry names:
+  #     *   <code>'*'</code> matches all entry names:
   #
   #             Dir.glob('*').take(3)  # => ["BSDL", "CONTRIBUTING.md", "COPYING"]
   #
-  #     *   `'c*'` matches entry names beginning with `'c'`:
+  #     *   <code>'c*'</code> matches entry names beginning with <code>'c'</code>:
   #
   #             Dir.glob('c*').take(3) # => ["CONTRIBUTING.md", "COPYING", "COPYING.ja"]
   #
-  #     *   `'*c'` matches entry names ending with `'c'`:
+  #     *   <code>'*c'</code> matches entry names ending with <code>'c'</code>:
   #
   #             Dir.glob('*c').take(3) # => ["addr2line.c", "array.c", "ast.c"]
   #
-  #     *   `'*c*'` matches entry names that contain `'c'`, even at the beginning
-  #         or end:
+  #     *   <code>'*c*'</code> matches entry names that contain <code>'c'</code>,
+  #         even at the beginning or end:
   #
   #             Dir.glob('*c*').take(3) # => ["CONTRIBUTING.md", "COPYING", "COPYING.ja"]
   #
   #     Does not match Unix-like hidden entry names ("dot files"). To include
   #     those in the matched entry names, use flag IO::FNM_DOTMATCH or something
-  #     like `'{*,.*}'`.
+  #     like <code>'{*,.*}'</code>.
   #
-  # *   `'**'`: Matches entry names recursively if followed by  the slash
-  #     character `'/'`:
+  # *   <code>'**'</code>: Matches entry names recursively if followed by  the
+  #     slash character <code>'/'</code>:
   #
   #         Dir.glob('**/').take(3) # => ["basictest/", "benchmark/", "benchmark/gc/"]
   #
   #     If the string pattern contains other characters or is not followed by a
-  #     slash character, it is equivalent to `'*'`.
+  #     slash character, it is equivalent to <code>'*'</code>.
   #
-  # *   `'?'` Matches any single character; similar in meaning to regexp `/./`:
+  # *   <code>'?'</code> Matches any single character; similar in meaning to
+  #     regexp <code>/./</code>:
   #
   #         Dir.glob('io.?') # => ["io.c"]
   #
-  # *   `'[*set*]'`: Matches any one character in the string *set*; behaves like a
-  #     [Regexp character class](rdoc-ref:Regexp@Character+Classes), including set
-  #     negation (`'[^a-z]'`):
+  # *   <code>'[_set_]'</code>: Matches any one character in the string *set*;
+  #     behaves like a [Regexp character
+  #     class](rdoc-ref:Regexp@Character+Classes), including set negation
+  #     (<code>'[^a-z]'</code>):
   #
   #         Dir.glob('*.[a-z][a-z]').take(3)
   #         # => ["CONTRIBUTING.md", "COPYING.ja", "KNOWNBUGS.rb"]
   #
-  # *   `'{*abc*,*xyz*}'`: Matches either string *abc* or string *xyz*; behaves
-  #     like [Regexp alternation](rdoc-ref:Regexp@Alternation):
+  # *   <code>'{_abc_,_xyz_}'</code>: Matches either string *abc* or string *xyz*;
+  #     behaves like [Regexp alternation](rdoc-ref:Regexp@Alternation):
   #
   #         Dir.glob('{LEGAL,BSDL}') # => ["LEGAL", "BSDL"]
   #
   #     More than two alternatives may be given.
   #
-  # *   `\`: Escapes the following metacharacter.
+  # *   <code>\</code>: Escapes the following metacharacter.
   #
   #     Note that on Windows, the backslash character may not be used in a string
-  #     pattern: `Dir['c:\\foo*']` will not work, use `Dir['c:/foo*']` instead.
+  #     pattern: <code>Dir['c:\foo*']</code> will not work, use
+  #     <code>Dir['c:/foo*']</code> instead.
   #
   # More examples (using the [simple file tree](rdoc-ref:Dir@About+the+Examples)):
   #
@@ -623,26 +633,26 @@ class Dir
   #
   # The flags for this method (other constants in File::Constants do not apply):
   #
-  # *   File::FNM_DOTMATCH: specifies that entry names beginning with `'.'` should
-  #     be considered for matching:
+  # *   File::FNM_DOTMATCH: specifies that entry names beginning with
+  #     <code>'.'</code> should be considered for matching:
   #
   #         Dir.glob('*').take(5)
   #         # => ["BSDL", "CONTRIBUTING.md", "COPYING", "COPYING.ja", "GPL"]
   #         Dir.glob('*', flags: File::FNM_DOTMATCH).take(5)
   #         # => [".", ".appveyor.yml", ".cirrus.yml", ".dir-locals.el", ".document"]
   #
-  # *   File::FNM_EXTGLOB: enables the pattern extension `'{*a*,*b*}'`, which
-  #     matches pattern *a* and pattern *b*; behaves like a [regexp
-  #     union](rdoc-ref:Regexp.union) (e.g., `'(?:*a*|*b*)'`):
+  # *   File::FNM_EXTGLOB: enables the pattern extension <code>'{_a_,_b_}'</code>,
+  #     which matches pattern *a* and pattern *b*; behaves like a [regexp
+  #     union](rdoc-ref:Regexp.union) (e.g., <code>'(?:_a_|_b_)'</code>):
   #
   #         pattern = '{LEGAL,BSDL}'
   #         Dir.glob(pattern)      # => ["LEGAL", "BSDL"]
   #
   # *   File::FNM_NOESCAPE: specifies that escaping with the backslash character
-  #     `'\'` is disabled; the character is not an escape character.
+  #     <code>'\'</code> is disabled; the character is not an escape character.
   #
-  # *   File::FNM_PATHNAME: specifies that metacharacters `'*'` and `'?'` do not
-  #     match directory separators.
+  # *   File::FNM_PATHNAME: specifies that metacharacters <code>'*'</code> and
+  #     <code>'?'</code> do not match directory separators.
   #
   # *   File::FNM_SHORTNAME: specifies that patterns may match short names if they
   #     exist; Windows only.
@@ -704,7 +714,7 @@ class Dir
   # system's encoding is used:
   #
   #     Dir.open('.').read.encoding                       # => #<Encoding:UTF-8>
-  #     Dir.open('.', encoding: 'US-ASCII').read.encoding # => #<Encoding:US-ASCII>
+  #     Dir.open('.', encoding: Encoding::US_ASCII).read.encoding # => #<Encoding:US-ASCII>
   #
   def self.open: (path dirname, ?encoding: encoding?) -> instance
                | [U] (path dirname, ?encoding: encoding?) { (instance) -> U } -> U
@@ -774,7 +784,8 @@ class Dir
   #   rdoc-file=dir.c
   #   - children -> array
   # -->
-  # Returns an array of the entry names in `self` except for `'.'` and `'..'`:
+  # Returns an array of the entry names in `self` except for <code>'.'</code> and
+  # <code>'..'</code>:
   #
   #     dir = Dir.new('/example')
   #     dir.children # => ["config.h", "lib", "main.rb"]
@@ -821,7 +832,8 @@ class Dir
   #   rdoc-file=dir.c
   #   - each_child {|entry_name| ... } -> self
   # -->
-  # Calls the block with each entry name in `self` except `'.'` and `'..'`:
+  # Calls the block with each entry name in `self` except <code>'.'</code> and
+  # <code>'..'</code>:
   #
   #     dir = Dir.new('/example')
   #     dir.each_child {|entry_name| p entry_name }

data/core/encoding.rbs

@@ -127,7 +127,7 @@ class Encoding
   # Sets default external encoding.  You should not set Encoding::default_external
   # in ruby code as strings created before changing the value may have a different
   # encoding from strings created after the value was changed., instead you should
-  # use `ruby -E` to invoke ruby with the correct default_external.
+  # use <code>ruby -E</code> to invoke ruby with the correct default_external.
   #
   # See Encoding::default_external for information on how the default external
   # encoding is used.
@@ -172,8 +172,8 @@ class Encoding
   # Sets default internal encoding or removes default internal encoding when
   # passed nil.  You should not set Encoding::default_internal in ruby code as
   # strings created before changing the value may have a different encoding from
-  # strings created after the change.  Instead you should use `ruby -E` to invoke
-  # ruby with the correct default_internal.
+  # strings created after the change.  Instead you should use <code>ruby -E</code>
+  # to invoke ruby with the correct default_internal.
   #
   # See Encoding::default_internal for information on how the default internal
   # encoding is used.
@@ -207,8 +207,8 @@ class Encoding
   #
   #
   # An ArgumentError is raised when no encoding with *name*. Only
-  # `Encoding.find("internal")` however returns nil when no encoding named
-  # "internal", in other words, when Ruby has no default internal encoding.
+  # <code>Encoding.find("internal")</code> however returns nil when no encoding
+  # named "internal", in other words, when Ruby has no default internal encoding.
   #
   def self.find: (encoding enc) -> Encoding?
 
@@ -281,7 +281,7 @@ class Encoding
   def inspect: () -> String
 
   # <!-- rdoc-file=encoding.c -->
-  # Returns the name of the encoding.
+  # The name of the encoding.
   #
   #     Encoding::UTF_8.name      #=> "UTF-8"
   #
@@ -297,12 +297,8 @@ class Encoding
   #
   def names: () -> Array[String]
 
-  # <!--
-  #   rdoc-file=encoding.c
-  #   - enc.name -> string
-  #   - enc.to_s -> string
-  # -->
-  # Returns the name of the encoding.
+  # <!-- rdoc-file=encoding.c -->
+  # The name of the encoding.
   #
   #     Encoding::UTF_8.name      #=> "UTF-8"
   #
@@ -785,7 +781,7 @@ class Encoding::Converter < Object
   #   - ec == other        -> true or false
   # -->
   #
-  def ==: (self) -> bool
+  def ==: (untyped) -> bool
 
   # <!--
   #   rdoc-file=transcode.c
@@ -923,8 +919,9 @@ class Encoding::Converter < Object
   #     p ec.primitive_convert(src, dst, nil, 1)             #=> :destination_buffer_full
   #     p ec.last_error      #=> nil
   #
-  def last_error: () -> Encoding::InvalidByteSequenceError?
-                | () -> Encoding::UndefinedConversionError?
+  def last_error: () -> ( Encoding::InvalidByteSequenceError
+                        | Encoding::UndefinedConversionError
+                        | nil )
 
   # <!--
   #   rdoc-file=transcode.c