rbs 3.6.1 → 3.9.5

data/stdlib/fileutils/0/fileutils.rbs

@@ -9,7 +9,6 @@
 # *   Supplements [class File](rdoc-ref:File) (but is not included or extended
 #     there).
 #
-#
 # Here, module FileUtils provides methods that are useful for:
 #
 # *   [Creating](rdoc-ref:FileUtils@Creating).
@@ -21,7 +20,6 @@
 # *   [Moving](rdoc-ref:FileUtils@Moving).
 # *   [Options](rdoc-ref:FileUtils@Options).
 #
-#
 # ### Creating
 #
 # *   ::mkdir: Creates directories.
@@ -33,7 +31,6 @@
 # *   ::ln_sf: Creates symbolic links, overwriting if necessary.
 # *   ::ln_sr: Creates symbolic links relative to targets
 #
-#
 # ### Deleting
 #
 # *   ::remove_dir: Removes a directory and its descendants.
@@ -47,14 +44,12 @@
 # *   ::rm_rf, ::rmtree: Like ::rm_r, but removes forcibly.
 # *   ::rmdir: Removes directories.
 #
-#
 # ### Querying
 #
 # *   ::pwd, ::getwd: Returns the path to the working directory.
 # *   ::uptodate?: Returns whether a given entry is newer than given other
 #     entries.
 #
-#
 # ### Setting
 #
 # *   ::cd, ::chdir: Sets the working directory.
@@ -65,14 +60,12 @@
 # *   ::touch: Sets modification and access times for entries, creating if
 #     necessary.
 #
-#
 # ### Comparing
 #
 # *   ::compare_file, ::cmp, ::identical?: Returns whether two entries are
 #     identical.
 # *   ::compare_stream: Returns whether two streams are identical.
 #
-#
 # ### Copying
 #
 # *   ::copy_entry: Recursively copies an entry.
@@ -84,12 +77,10 @@
 # *   ::install: Recursively copies files, optionally setting mode, owner, and
 #     group.
 #
-#
 # ### Moving
 #
 # *   ::mv, ::move: Moves entries.
 #
-#
 # ### Options
 #
 # *   ::collect_method: Returns the names of methods that accept a given option.
@@ -98,7 +89,6 @@
 # *   ::options: Returns all option names.
 # *   ::options_of: Returns the names of the options for a given method.
 #
-#
 # ## Path Arguments
 #
 # Some methods in FileUtils accept *path* arguments, which are interpreted as
@@ -108,7 +98,6 @@
 # *   If the argument has method `:to_path`, it is converted via that method.
 # *   If the argument has method `:to_str`, it is converted via that method.
 #
-#
 # ## About the Examples
 #
 # Some examples here involve trees of file entries. For these, we sometimes
@@ -149,28 +138,23 @@
 #     *   A world-writable descendant directory.
 #     *   A symbolic link.
 #
-#
-#
 # To avoid that vulnerability, you can use this method to remove entries:
 #
 # *   FileUtils.remove_entry_secure: removes recursively if the target path
 #     points to a directory.
 #
-#
 # Also available are these methods, each of which calls
 # FileUtils.remove_entry_secure:
 #
 # *   FileUtils.rm_r with keyword argument `secure: true`.
 # *   FileUtils.rm_rf with keyword argument `secure: true`.
 #
-#
 # Finally, this method for moving entries calls FileUtils.remove_entry_secure if
 # the source and destination are on different file systems (which means that the
 # "move" is really a copy and remove):
 #
 # *   FileUtils.mv with keyword argument `secure: true`.
 #
-#
 # Method FileUtils.remove_entry_secure removes securely by applying a special
 # pre-process:
 #
@@ -180,7 +164,6 @@
 # *   The owner of the target directory should be either the current process or
 #     the super user (root).
 #
-#
 # WARNING: You must ensure that **ALL** parent directories cannot be moved by
 # other untrusted users.  For example, parent directories should not be owned by
 # untrusted users, and should not be world writable except when the sticky bit
@@ -194,6 +177,9 @@
 #     52).
 #
 module FileUtils
+  # <!-- rdoc-file=lib/fileutils.rb -->
+  # The version number.
+  #
   VERSION: String
 
   type mode = Integer | String
@@ -237,7 +223,6 @@ module FileUtils
   #         cd ..
   #         cd fileutils
   #
-  #
   # Related: FileUtils.pwd.
   #
   def self?.cd: (path dir, ?verbose: boolish) -> void
@@ -270,7 +255,6 @@ module FileUtils
   # *   Modifies each entry that is a symbolic link using
   #     [File.lchmod](rdoc-ref:File.lchmod).
   #
-  #
   # Argument `list` or its elements should be [interpretable as
   # paths](rdoc-ref:FileUtils@Path+Arguments).
   #
@@ -292,14 +276,12 @@ module FileUtils
   #         *   `'o'`: permissions apply to other users not in the file's group.
   #         *   `'a'` (the default): permissions apply to all users.
   #
-  #
   #     *   `operator` may be one of these letters:
   #
   #         *   `'+'`: adds permissions.
   #         *   `'-'`: removes permissions.
   #         *   `'='`: sets (replaces) permissions.
   #
-  #
   #     *   `perms` (may be repeated, with separating commas) may be any
   #         combination of these letters:
   #
@@ -310,14 +292,11 @@ module FileUtils
   #         *   `'s'`: Uid or gid.
   #         *   `'t'`: Sticky bit.
   #
-  #
-  #
   #     Examples:
   #
   #         FileUtils.chmod('u=wrx,go=rx', 'src1.txt')
   #         FileUtils.chmod('u=wrx,go=rx', '/usr/bin/ruby')
   #
-  #
   # Keyword arguments:
   #
   # *   `noop: true` - does not change permissions; returns `nil`.
@@ -335,7 +314,6 @@ module FileUtils
   #         chmod u=wrx,go=rx src1.txt
   #         chmod u=wrx,go=rx /usr/bin/ruby
   #
-  #
   # Related: FileUtils.chmod_R.
   #
   def self?.chmod: (mode mode, pathlist list, ?noop: boolish, ?verbose: boolish) -> void
@@ -361,7 +339,6 @@ module FileUtils
   # *   Modifies each entry that is a symbolic link using
   #     [File.lchown](rdoc-ref:File.lchown).
   #
-  #
   # Argument `list` or its elements should be [interpretable as
   # paths](rdoc-ref:FileUtils@Path+Arguments).
   #
@@ -373,7 +350,6 @@ module FileUtils
   #     group is not changed.
   # *   The user must be a member of the group.
   #
-  #
   # Examples:
   #
   #     # One path.
@@ -414,7 +390,6 @@ module FileUtils
   #         chown user2:group1 src0.txt
   #         chown user2:group1 .
   #
-  #
   # Related: FileUtils.chown_R.
   #
   def self?.chown: (String? user, String? group, pathlist list, ?noop: boolish, ?verbose: boolish) -> void
@@ -553,7 +528,6 @@ module FileUtils
   # *   `preserve: true` - preserves file times.
   # *   `remove_destination: true` - removes `dest` before copying files.
   #
-  #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
   def self?.copy_entry: (path src, path dest, ?boolish preserve, ?boolish dereference_root, ?boolish remove_destination) -> void
@@ -580,7 +554,6 @@ module FileUtils
   # *   `preserve: true` - preserves file times.
   # *   `remove_destination: true` - removes `dest` before copying files.
   #
-  #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
   def self?.copy_file: (path src, path dest, ?boolish preserve, ?boolish dereference) -> void
@@ -647,7 +620,6 @@ module FileUtils
   #         cp src1.txt dest1
   #         cp src2.txt src2.dat dest2
   #
-  #
   # Raises an exception if `src` is a directory.
   #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
@@ -763,7 +735,6 @@ module FileUtils
   #         cp -lr src1 dest1
   #         cp -lr src2/sub0 src2/sub1 dest2
   #
-  #
   # Raises an exception if `dest` is the path to an existing file or directory and
   # keyword argument `remove_destination: true` is not given.
   #
@@ -869,7 +840,6 @@ module FileUtils
   #         cp -r src2 dest2
   #         cp -r src3 dest3
   #
-  #
   # Raises an exception of `src` is the path to a directory and `dest` is the path
   # to a file.
   #
@@ -954,7 +924,6 @@ module FileUtils
   #         install -c src1.txt dest1.txt
   #         install -c src2.txt dest2
   #
-  #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
   def self?.install: (path src, path dest, ?mode: mode?, ?owner: String?, ?group: String?, ?preserve: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -999,7 +968,6 @@ module FileUtils
   # *   `dereference_root: true` - dereferences `src` if it is a symbolic link.
   # *   `remove_destination: true` - removes `dest` before creating links.
   #
-  #
   # Raises an exception if `dest` is the path to an existing file or directory and
   # keyword argument `remove_destination: true` is not given.
   #
@@ -1058,7 +1026,6 @@ module FileUtils
   #         ln tmp2/t.dat tmp3
   #         ln tmp0/t.txt tmp2/t.dat tmp4/
   #
-  #
   # Raises an exception if `dest` is the path to an existing file and keyword
   # argument `force` is not `true`.
   #
@@ -1110,7 +1077,6 @@ module FileUtils
   #
   #         FileUtils.ln_s('src1.txt', 'dest1.txt') # Raises Errno::EEXIST.
   #
-  #
   # If `dest` is the path to a directory, creates a symbolic link at `dest/src`
   # pointing to `src`:
   #
@@ -1150,7 +1116,6 @@ module FileUtils
   #         ln -sf src2.txt dest2.txt
   #         ln -s srcdir3/src0.txt srcdir3/src1.txt destdir3
   #
-  #
   # Related: FileUtils.ln_sf.
   #
   def self?.ln_s: (pathlist src, path dest, ?force: boolish, ?relative: boolish, ?target_directory: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1216,7 +1181,6 @@ module FileUtils
   #         mkdir tmp0 tmp1
   #         mkdir -m 700 tmp2 tmp3
   #
-  #
   # Raises an exception if any path points to an existing file or directory, or if
   # for any reason a directory cannot be created.
   #
@@ -1257,7 +1221,6 @@ module FileUtils
   #         mkdir -p tmp0 tmp1
   #         mkdir -p -m 700 tmp2 tmp3
   #
-  #
   # Raises an exception if for any reason a directory cannot be created.
   #
   # FileUtils.mkpath and FileUtils.makedirs are aliases for FileUtils.mkdir_p.
@@ -1524,7 +1487,6 @@ module FileUtils
   #
   #         rm src0.dat src0.txt
   #
-  #
   # Related: [methods for deleting](rdoc-ref:FileUtils@Deleting).
   #
   def self?.rm: (pathlist list, ?force: boolish, ?noop: boolish, ?verbose: boolish) -> void
@@ -1625,7 +1587,6 @@ module FileUtils
   #         rm -r src0.dat src0.txt
   #         rm -r src1
   #
-  #
   # Related: [methods for deleting](rdoc-ref:FileUtils@Deleting).
   #
   def self?.rm_r: (pathlist list, ?force: boolish, ?noop: boolish, ?verbose: boolish, ?secure: boolish) -> void
@@ -1695,7 +1656,6 @@ module FileUtils
   #         rmdir -p tmp0/tmp1 tmp2/tmp3
   #         rmdir -p tmp4/tmp5
   #
-  #
   # Raises an exception if a directory does not exist or if for any reason a
   # directory cannot be removed.
   #
@@ -1749,7 +1709,6 @@ module FileUtils
   #         touch src0.txt src0.dat
   #         touch src0.txt
   #
-  #
   # Related: FileUtils.uptodate?.
   #
   def self?.touch: (pathlist list, ?noop: boolish, ?verbose: boolish, ?mtime: (Time | Numeric)?, ?nocreate: boolish) -> void

data/stdlib/io-console/0/io-console.rbs

@@ -39,22 +39,33 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - beep()
+  #   - io.beep
   # -->
+  # Beeps on the output console.
+  #
+  # You must require 'io/console' to use this method.
   #
   def beep: () -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - check_winsize_changed()
+  #   - io.check_winsize_changed { ... }   -> io
   # -->
+  # Yields while console input events are queued.
+  #
+  # This method is Windows only.
+  #
+  # You must require 'io/console' to use this method.
   #
   def check_winsize_changed: () { () -> void } -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - clear_screen()
+  #   - io.clear_screen            -> io
   # -->
+  # Clears the entire screen and moves the cursor top-left corner.
+  #
+  # You must require 'io/console' to use this method.
   #
   def clear_screen: () -> self
 
@@ -119,36 +130,53 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor=(p1)
+  #   - io.cursor = [line, column]         -> io
   # -->
+  # Same as `io.goto(line, column)`
+  #
+  # See IO#goto.
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor=: ([ Integer, Integer ]) -> [ Integer, Integer ]
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor_down(p1)
+  #   - io.cursor_down(n)          -> io
   # -->
+  # Moves the cursor down `n` lines.
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor_down: (int) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor_left(p1)
+  #   - io.cursor_left(n)          -> io
   # -->
+  # Moves the cursor left `n` columns.
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor_left: (int) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor_right(p1)
+  #   - io.cursor_right(n)         -> io
   # -->
+  # Moves the cursor right `n` columns.
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor_right: (int) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - cursor_up(p1)
+  #   - io.cursor_up(n)            -> io
   # -->
+  # Moves the cursor up `n` lines.
+  #
+  # You must require 'io/console' to use this method.
   #
   def cursor_up: (int) -> self
 
@@ -175,15 +203,23 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - erase_line(p1)
+  #   - io.erase_line(mode)        -> io
   # -->
+  # Erases the line at the cursor corresponding to `mode`. `mode` may be either:
+  # 0: after cursor 1: before and cursor 2: entire line
+  #
+  # You must require 'io/console' to use this method.
   #
   def erase_line: (0 | 1 | 2 | nil) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - erase_screen(p1)
+  #   - io.erase_screen(mode)      -> io
   # -->
+  # Erases the screen at the cursor corresponding to `mode`. `mode` may be either:
+  # 0: after cursor 1: before and cursor 2: entire screen
+  #
+  # You must require 'io/console' to use this method.
   #
   def erase_screen: (0 | 1 | 2 | 3 | nil) -> self
 
@@ -220,15 +256,21 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - goto(p1, p2)
+  #   - io.goto(line, column)      -> io
   # -->
+  # Set the cursor position at `line` and `column`.
+  #
+  # You must require 'io/console' to use this method.
   #
   def goto: (int, int) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - goto_column(p1)
+  #   - io.goto_column(column)     -> io
   # -->
+  # Set the cursor position at `column` in the same line of the current position.
+  #
+  # You must require 'io/console' to use this method.
   #
   def goto_column: (int) -> self
 
@@ -278,8 +320,14 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - pressed?(p1)
+  #   - io.pressed?(key)   -> bool
   # -->
+  # Returns `true` if `key` is pressed.  `key` may be a virtual key code or its
+  # name (String or Symbol) with out "VK_" prefix.
+  #
+  # This method is Windows only.
+  #
+  # You must require 'io/console' to use this method.
   #
   def pressed?: (Integer | interned) -> bool
 
@@ -324,15 +372,21 @@ class IO
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - scroll_backward(p1)
+  #   - io.scroll_backward(n)      -> io
   # -->
+  # Scrolls the entire scrolls backward `n` lines.
+  #
+  # You must require 'io/console' to use this method.
   #
   def scroll_backward: (int) -> self
 
   # <!--
   #   rdoc-file=ext/io/console/console.c
-  #   - scroll_forward(p1)
+  #   - io.scroll_forward(n)       -> io
   # -->
+  # Scrolls the entire scrolls forward `n` lines.
+  #
+  # You must require 'io/console' to use this method.
   #
   def scroll_forward: (int) -> self
 

data/stdlib/ipaddr/0/ipaddr.rbs

@@ -37,7 +37,8 @@ class IPAddr
   #   - ntop(addr)
   # -->
   # Convert a network byte ordered string form of an IP address into human
-  # readable form.
+  # readable form. It expects the string to be encoded in Encoding::ASCII_8BIT
+  # (BINARY).
   #
   def self.ntop: (String addr) -> String
 
@@ -240,8 +241,10 @@ class IPAddr
   #   - link_local?()
   # -->
   # Returns true if the ipaddr is a link-local address.  IPv4 addresses in
-  # 169.254.0.0/16 reserved by RFC 3927 and Link-Local IPv6 Unicast Addresses in
-  # fe80::/10 reserved by RFC 4291 are considered link-local.
+  # 169.254.0.0/16 reserved by RFC 3927 and link-local IPv6 Unicast Addresses in
+  # fe80::/10 reserved by RFC 4291 are considered link-local. Link-local IPv4
+  # addresses in the IPv4-mapped IPv6 address range are also considered
+  # link-local.
   #
   def link_local?: () -> bool
 
@@ -249,7 +252,8 @@ class IPAddr
   #   rdoc-file=lib/ipaddr.rb
   #   - loopback?()
   # -->
-  # Returns true if the ipaddr is a loopback address.
+  # Returns true if the ipaddr is a loopback address. Loopback IPv4 addresses in
+  # the IPv4-mapped IPv6 address range are also considered as loopback addresses.
   #
   def loopback?: () -> bool
 
@@ -272,6 +276,14 @@ class IPAddr
   #
   def native: () -> IPAddr
 
+  # <!--
+  #   rdoc-file=lib/ipaddr.rb
+  #   - netmask()
+  # -->
+  # Returns the netmask in string format e.g. 255.255.0.0
+  #
+  def netmask: () -> String
+
   # <!--
   #   rdoc-file=lib/ipaddr.rb
   #   - prefix()