rbs 3.3.2 → 3.4.0

data/stdlib/optparse/0/optparse.rbs

@@ -1,7 +1,7 @@
 # <!-- rdoc-file=lib/optparse.rb -->
 # ## OptionParser
 #
-# ### New to OptionParser?
+# ### New to `OptionParser`?
 #
 # See the [Tutorial](optparse/tutorial.rdoc).
 #
@@ -106,13 +106,17 @@
 # OptionParser supports the ability to coerce command line arguments into
 # objects for us.
 #
-# OptionParser comes with a few ready-to-use kinds of  type coercion. They are:
-#
-# *   Date  -- Anything accepted by `Date.parse`
-# *   DateTime -- Anything accepted by `DateTime.parse`
-# *   Time -- Anything accepted by `Time.httpdate` or `Time.parse`
-# *   URI  -- Anything accepted by `URI.parse`
-# *   Shellwords -- Anything accepted by `Shellwords.shellwords`
+# OptionParser comes with a few ready-to-use kinds of type coercion. They are:
+#
+# *   Date  -- Anything accepted by `Date.parse` (need to require
+#     `optparse/date`)
+# *   DateTime -- Anything accepted by `DateTime.parse` (need to require
+#     `optparse/date`)
+# *   Time -- Anything accepted by `Time.httpdate` or `Time.parse` (need to
+#     require `optparse/time`)
+# *   URI  -- Anything accepted by `URI.parse` (need to require `optparse/uri`)
+# *   Shellwords -- Anything accepted by `Shellwords.shellwords` (need to
+#     require `optparse/shellwords`)
 # *   String -- Any non-empty string
 # *   Integer -- Any integer. Will convert octal. (e.g. 124, -3, 040)
 # *   Float -- Any float. (e.g. 10, 3.14, -100E+13)
@@ -400,7 +404,7 @@ class OptionParser
 
   # <!--
   #   rdoc-file=lib/optparse.rb
-  #   - getopts(*args)
+  #   - getopts(*args, symbolize_names: false)
   # -->
   # See #getopts.
   #
@@ -598,7 +602,7 @@ class OptionParser
 
   # <!--
   #   rdoc-file=lib/optparse.rb
-  #   - getopts(*args)
+  #   - getopts(*args, symbolize_names: false)
   # -->
   # Wrapper method for getopts.rb.
   #
@@ -609,6 +613,16 @@ class OptionParser
   #     # params["bar"] = "x"  # --bar x
   #     # params["zot"] = "z"  # --zot Z
   #
+  # Option `symbolize_names` (boolean) specifies whether returned Hash keys should
+  # be Symbols; defaults to `false` (use Strings).
+  #
+  #     params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option", symbolize_names: true)
+  #     # params[:a] = true   # -a
+  #     # params[:b] = "1"    # -b1
+  #     # params[:foo] = "1"  # --foo
+  #     # params[:bar] = "x"  # --bar x
+  #     # params[:zot] = "z"  # --zot Z
+  #
   def getopts: (*String options) -> Hash[String, untyped]
              | (Array[String] args, *String options) -> Hash[String, untyped]
 
@@ -1099,7 +1113,7 @@ module OptionParser::Arguable
 
   # <!--
   #   rdoc-file=lib/optparse.rb
-  #   - getopts(*args)
+  #   - getopts(*args, symbolize_names: false)
   # -->
   # Substitution of getopts is possible as follows. Also see OptionParser#getopts.
   #

data/stdlib/pathname/0/pathname.rbs

@@ -1410,5 +1410,5 @@ module Kernel
   #
   # See also Pathname::new for more information.
   #
-  def self?.Pathname: (String | Pathname) -> Pathname
+  def self?.Pathname: (string | Pathname) -> Pathname
 end

data/stdlib/pp/0/pp.rbs

@@ -38,7 +38,8 @@
 # ## Output Customization
 #
 # To define a customized pretty printing function for your classes, redefine
-# method `#pretty_print(pp)` in the class.
+# method `#pretty_print(pp)` in the class. Note that `require 'pp'` is needed
+# before redefining `#pretty_print(pp)`.
 #
 # `#pretty_print` takes the `pp` argument, which is an instance of the PP class.
 # The method uses #text, #breakable, #nest, #group and #pp to print the object.
@@ -291,10 +292,6 @@ module Kernel
   # -->
   # Returns a pretty printed object as a string.
   #
-  # In order to use this method you must first require the PP module:
-  #
-  #     require 'pp'
-  #
   # See the PP module for more information.
   #
   def pretty_inspect: () -> String

data/stdlib/prettyprint/0/prettyprint.rbs

@@ -25,10 +25,10 @@
 #
 # ## References
 # Christian Lindig, Strictly Pretty, March 2000,
-# http://www.st.cs.uni-sb.de/~lindig/papers/#pretty
+# https://lindig.github.io/papers/strictly-pretty-2000.pdf
 #
 # Philip Wadler, A prettier printer, March 1998,
-# http://homepages.inf.ed.ac.uk/wadler/topics/language-design.html#prettier
+# https://homepages.inf.ed.ac.uk/wadler/topics/language-design.html#prettier
 #
 # ## Author
 # Tanaka Akira <akr@fsij.org>

data/stdlib/pstore/0/pstore.rbs

@@ -352,8 +352,7 @@ class PStore
   #   - abort()
   # -->
   # Exits the current transaction block, discarding any changes specified in the
-  # transaction block. See [Committing or
-  # Aborting](rdoc-ref:PStore@Committing+or+Aborting).
+  # [transaction block](rdoc-ref:PStore@The+Transaction+Block).
   #
   # Raises an exception if called outside a transaction block.
   #
@@ -364,8 +363,7 @@ class PStore
   #   - commit()
   # -->
   # Exits the current transaction block, committing any changes specified in the
-  # transaction block. See [Committing or
-  # Aborting](rdoc-ref:PStore@Committing+or+Aborting).
+  # [transaction block](rdoc-ref:PStore@The+Transaction+Block).
   #
   # Raises an exception if called outside a transaction block.
   #

data/stdlib/rdoc/0/comment.rbs

@@ -7,8 +7,7 @@ module RDoc
   # Each comment may have a different markup format set by #format=.  By default
   # 'rdoc' is used.  The :markup: directive tells RDoc which format to use.
   #
-  # See RDoc::Markup@Other+directives for instructions on adding an alternate
-  # format.
+  # See RDoc::MarkupReference@Directive+for+Specifying+RDoc+Source+Format.
   #
   class Comment
     # <!-- rdoc-file=lib/rdoc/comment.rb -->

data/stdlib/resolv/0/resolv.rbs

@@ -128,7 +128,7 @@ class Resolv
 
   # <!--
   #   rdoc-file=lib/resolv.rb
-  #   - new(resolvers=[Hosts.new, DNS.new])
+  #   - new(resolvers=nil, use_ipv6: nil)
   # -->
   # Creates a new Resolv using `resolvers`.
   #
@@ -351,6 +351,8 @@ class Resolv::DNS
   # :   Must contain :nameserver, :search and :ndots keys.
   #
   # :nameserver_port can be used to specify port number of nameserver address.
+  # :raise_timeout_errors can be used to raise timeout errors as exceptions
+  # instead of treating the same as an NXDOMAIN response.
   #
   # The value of :nameserver should be an address string or an array of address
   # strings.
@@ -921,7 +923,7 @@ end
 # A generic resource abstract class.
 #
 class Resolv::DNS::Resource::Generic < Resolv::DNS::Resource
-  def self.create: (Integer type_value, Integer class_value) -> instance
+  def self.create: (Integer type_value, Integer class_value) -> Class
 
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 

data/stdlib/socket/0/socket.rbs

@@ -1517,8 +1517,8 @@ Socket::AF_IMPLINK: Integer
 #
 Socket::AF_INET: Integer
 
-# <!-- rdoc-file=ext/socket/constdefs.c -->
-# IPv6 protocol
+# <!-- rdoc-file=lib/ipaddr.rb -->
+# IPv6 protocol family
 #
 Socket::AF_INET6: Integer
 

data/stdlib/socket/0/unix_socket.rbs

@@ -9,7 +9,7 @@ class UNIXSocket < BasicSocket
   # -->
   # Creates a pair of sockets connected to each other.
   #
-  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  # *type* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
   #
   # *protocol* should be a protocol defined in the domain. 0 is default protocol
   # for the domain.
@@ -28,7 +28,7 @@ class UNIXSocket < BasicSocket
   # -->
   # Creates a pair of sockets connected to each other.
   #
-  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  # *type* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
   #
   # *protocol* should be a protocol defined in the domain. 0 is default protocol
   # for the domain.

data/stdlib/strscan/0/string_scanner.rbs

@@ -567,8 +567,9 @@ class StringScanner
   # method is obsolete; use #eos? instead.
   #
   #     s = StringScanner.new('test string')
-  #     s.eos?              # These two
-  #     s.rest?             # are opposites.
+  #     # These two are opposites
+  #     s.eos? # => false
+  #     s.rest? # => true
   #
   def rest?: () -> bool
 

data/stdlib/tempfile/0/tempfile.rbs

@@ -48,7 +48,7 @@
 # Note that Tempfile.create returns a File instance instead of a Tempfile, which
 # also avoids the overhead and complications of delegation.
 #
-#     Tempfile.open('foo') do |file|
+#     Tempfile.create('foo') do |file|
 #        # ...do something with file...
 #     end
 #