rbs 3.7.0 → 3.8.0.pre.1

data/stdlib/date/0/date.rbs

@@ -7,7 +7,6 @@
 # *   You need only Gregorian dates (and not Julian dates); see [Julian and
 #     Gregorian Calendars](rdoc-ref:calendars.rdoc).
 #
-#
 # A Date object, once created, is immutable, and cannot be modified.
 #
 # ## Creating a Date
@@ -52,7 +51,6 @@
 #         Date.strptime('1999 52 5', '%Y %W %u')   # => #<Date: 1999-12-31>
 #         Date.strptime('fri31dec99', '%a%d%b%y')  # => #<Date: 1999-12-31>
 #
-#
 # See also the specialized methods in ["Specialized Format Strings" in Formats
 # for Dates and
 # Times](rdoc-ref:strftime_formatting.rdoc@Specialized+Format+Strings)
@@ -311,7 +309,6 @@ class Date
   #         Date.commercial(2020, 1, 1).to_s # => "2019-12-30"
   #         Date.commercial(2020, 1, 7).to_s # => "2020-01-05"
   #
-  #
   # See argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   #
   # Related: Date.jd, Date.new, Date.ordinal.
@@ -349,7 +346,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._httpdate (returns a hash).
   #
   def self.httpdate: (String str, ?Integer start) -> Date
@@ -371,7 +367,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._iso8601 (returns a hash).
   #
   def self.iso8601: (String str, ?Integer start) -> Date
@@ -398,7 +393,6 @@ class Date
   #
   #         Date.jd(Date::ITALY - 1).julian?    # => true
   #
-  #
   # See argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   #
   # Related: Date.new.
@@ -426,7 +420,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._jisx0301 (returns a hash).
   #
   def self.jisx0301: (String str, ?Integer start) -> Date
@@ -520,7 +513,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._parse (returns a hash).
   #
   def self.parse: (?String str, ?boolish complete, ?Integer start) -> Date
@@ -542,7 +534,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def self.rfc2822: (String str, ?Integer start) -> Date
@@ -563,7 +554,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._rfc3339 (returns a hash).
   #
   def self.rfc3339: (String str, ?Integer start) -> Date
@@ -585,7 +575,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def self.rfc822: (String str, ?Integer start) -> Date
@@ -728,7 +717,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._xmlschema (returns a hash).
   #
   def self.xmlschema: (String str, ?Integer start) -> Date
@@ -755,10 +743,10 @@ class Date
   #   rdoc-file=ext/date/date_core.c
   #   - d - other  ->  date or rational
   # -->
-  # Returns the difference between the two dates if the other is a date object.
-  # If the other is a numeric value, returns a date object pointing `other` days
-  # before self.  If the other is a fractional number, assumes its precision is at
-  # most nanosecond.
+  # If the other is a date object, returns a Rational whose value is the
+  # difference between the two dates in days. If the other is a numeric value,
+  # returns a date object pointing `other` days before self. If the other is a
+  # fractional number, assumes its precision is at most nanosecond.
   #
   #     Date.new(2001,2,3) - 1   #=> #<Date: 2001-02-02 ...>
   #     DateTime.new(2001,2,3) - Rational(1,2)
@@ -810,7 +798,6 @@ class Date
   # *   `1` if `other` is smaller.
   # *   `nil` if the two are incomparable.
   #
-  #
   # Argument `other` may be:
   #
   # *   Another Date object:
@@ -1338,7 +1325,6 @@ class Date
   # *   Argument [start](rdoc-ref:calendars.rdoc@Argument+start).
   # *   Argument [limit](rdoc-ref:Date@Argument+limit).
   #
-  #
   # Related: Date._rfc2822 (returns a hash).
   #
   def rfc822: () -> String
@@ -1385,7 +1371,6 @@ class Date
   # *   The last date is the last one that is before or equal to `limit`, which
   #     should be a Date object.
   #
-  #
   # Example:
   #
   #     limit = Date.new(2001, 12, 31)

data/stdlib/did_you_mean/0/did_you_mean.rbs

@@ -71,11 +71,6 @@
 #     # => NoMethodError (undefined method `zeor?' for 1:Integer)
 #
 module DidYouMean
-  # <!-- rdoc-file=lib/did_you_mean.rb -->
-  # TODO: Remove on the 3.4 development start:
-  #
-  SPELL_CHECKERS: untyped
-
   NameErrorCheckers: Object
 
   VERSION: String

data/stdlib/digest/0/digest.rbs

@@ -51,11 +51,14 @@
 #
 # MD5
 # :   See RFC 1321 The MD5 Message-Digest Algorithm
+#
 # RIPEMD-160
 # :   As Digest::RMD160. See
 #     http://homes.esat.kuleuven.be/~bosselae/ripemd160.html.
+#
 # SHA1
 # :   See FIPS 180 Secure Hash Standard.
+#
 # SHA2 family
 # :   See FIPS 180 Secure Hash Standard which defines the following algorithms:
 #     *   SHA512
@@ -63,7 +66,6 @@
 #     *   SHA256
 #
 #
-#
 # The latest versions of the FIPS publications can be found here:
 # http://csrc.nist.gov/publications/PubsFIPS.html.
 #
@@ -398,7 +400,7 @@ end
 #     };
 #
 #     rb_ivar_set(cDigest_SHA1, rb_intern("metadata"),
-#                 Data_Wrap_Struct(0, 0, 0, (void *)&sha1));
+#                 rb_digest_make_metadata(&sha1));
 #
 class Digest::Base < Digest::Class
   # <!-- rdoc-file=ext/digest/digest.c -->
@@ -521,12 +523,33 @@ end
 class Digest::RMD160 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA256 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA384 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA512 < Digest::Base
 end
 

data/stdlib/erb/0/erb.rbs

@@ -41,7 +41,6 @@
 # *   the nature of the tags that are recognized;
 # *   the binding used to resolve local variables in the template.
 #
-#
 # See the ERB.new and ERB#result methods for more detail.
 #
 # ## Character encodings

data/stdlib/etc/0/etc.rbs

@@ -9,7 +9,7 @@
 # The Etc module provides a more reliable way to access information about the
 # logged in user than environment variables such as +$USER+.
 #
-# ## Example:
+# **Example:**
 #
 #     require 'etc'
 #
@@ -27,7 +27,7 @@
 module Etc
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - confstr(p1)
+  #   - confstr(name)        ->  String
   # -->
   # Returns system configuration variable using confstr().
   #
@@ -46,7 +46,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - endgrent()
+  #   - endgrent
   # -->
   # Ends the process of scanning through the `/etc/group` file begun by
   # ::getgrent, and closes the file.
@@ -55,7 +55,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - endpwent()
+  #   - endpwent
   # -->
   # Ends the process of scanning through the `/etc/passwd` file begun with
   # ::getpwent, and closes the file.
@@ -64,7 +64,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getgrent()
+  #   - getgrent     ->  Etc::Group
   # -->
   # Returns an entry from the `/etc/group` file.
   #
@@ -80,7 +80,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getgrgid(group_id)  ->       Group
+  #   - getgrgid(group_id)  ->       Etc::Group
   # -->
   # Returns information about the group with specified integer `group_id`, as
   # found in `/etc/group`.
@@ -89,7 +89,7 @@ module Etc
   #
   # See the unix manpage for `getgrgid(3)` for more detail.
   #
-  # ### Example:
+  # **Example:**
   #
   #     Etc.getgrgid(100)
   #     #=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -98,7 +98,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getgrnam(name)       ->  Group
+  #   - getgrnam(name)       ->  Etc::Group
   # -->
   # Returns information about the group with specified `name`, as found in
   # `/etc/group`.
@@ -107,7 +107,7 @@ module Etc
   #
   # See the unix manpage for `getgrnam(3)` for more detail.
   #
-  # ### Example:
+  # **Example:**
   #
   #     Etc.getgrnam('users')
   #     #=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -134,7 +134,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getpwent()
+  #   - getpwent     ->  Etc::Passwd
   # -->
   # Returns an entry from the `/etc/passwd` file.
   #
@@ -150,7 +150,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getpwnam(name)       ->  Passwd
+  #   - getpwnam(name)       ->  Etc::Passwd
   # -->
   # Returns the `/etc/passwd` information for the user with specified login
   # `name`.
@@ -159,7 +159,7 @@ module Etc
   #
   # See the unix manpage for `getpwnam(3)` for more detail.
   #
-  # ### Example:
+  # **Example:**
   #
   #     Etc.getpwnam('root')
   #     #=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -168,7 +168,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - getpwuid(uid)        ->  Passwd
+  #   - getpwuid(uid)        ->  Etc::Passwd
   # -->
   # Returns the `/etc/passwd` information for the user with the given integer
   # `uid`.
@@ -179,7 +179,7 @@ module Etc
   #
   # See the unix manpage for `getpwuid(3)` for more detail.
   #
-  # ### Example:
+  # **Example:**
   #
   #     Etc.getpwuid(0)
   #     #=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -188,7 +188,8 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - group()
+  #   - group { |struct| block }
+  #   - group                                ->  Etc::Group
   # -->
   # Provides a convenient Ruby iterator which executes a block for each entry in
   # the `/etc/group` file.
@@ -197,7 +198,7 @@ module Etc
   #
   # See ::getgrent above for details.
   #
-  # Example:
+  # **Example:**
   #
   #     require 'etc'
   #
@@ -210,7 +211,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - nprocessors()
+  #   - nprocessors  ->  Integer
   # -->
   # Returns the number of online processors.
   #
@@ -222,8 +223,7 @@ module Etc
   # *   sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD,
   #     DragonFly BSD, OpenIndiana, Mac OS X, AIX
   #
-  #
-  # Example:
+  # **Example:**
   #
   #     require 'etc'
   #     p Etc.nprocessors #=> 4
@@ -232,7 +232,7 @@ module Etc
   # process is bound to specific cpus. This is intended for getting better
   # parallel processing.
   #
-  # Example: (Linux)
+  # **Example:** (Linux)
   #
   #     linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors"  #=> 2
   #
@@ -240,8 +240,8 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - Etc.passwd { |struct| block }        ->  Passwd
-  #   - Etc.passwd                   ->  Passwd
+  #   - passwd { |struct| block }
+  #   - passwd                               ->  Etc::Passwd
   # -->
   # Provides a convenient Ruby iterator which executes a block for each entry in
   # the `/etc/passwd` file.
@@ -250,7 +250,7 @@ module Etc
   #
   # See ::getpwent above for details.
   #
-  # Example:
+  # **Example:**
   #
   #     require 'etc'
   #
@@ -263,7 +263,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - setgrent()
+  #   - setgrent
   # -->
   # Resets the process of reading the `/etc/group` file, so that the next call to
   # ::getgrent will return the first entry again.
@@ -272,7 +272,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - setpwent()
+  #   - setpwent
   # -->
   # Resets the process of reading the `/etc/passwd` file, so that the next call to
   # ::getpwent will return the first entry again.
@@ -281,7 +281,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - sysconf(p1)
+  #   - sysconf(name)        ->  Integer
   # -->
   # Returns system configuration variable using sysconf().
   #
@@ -297,7 +297,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - sysconfdir()
+  #   - sysconfdir   ->  String
   # -->
   # Returns system configuration directory.
   #
@@ -311,7 +311,7 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - systmpdir()
+  #   - systmpdir    ->  String
   # -->
   # Returns system temporary directory; typically "/tmp".
   #
@@ -319,14 +319,14 @@ module Etc
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
-  #   - uname()
+  #   - uname        -> hash
   # -->
   # Returns the system information obtained by uname system call.
   #
   # The return value is a hash which has 5 keys at least:
   #     :sysname, :nodename, :release, :version, :machine
   #
-  # Example:
+  # **Example:**
   #
   #     require 'etc'
   #     require 'pp'
@@ -652,6 +652,9 @@ module Etc
 
   SC_XOPEN_VERSION: Integer
 
+  # <!-- rdoc-file=ext/etc/etc.c -->
+  # The version
+  #
   VERSION: String
 
   # <!-- rdoc-file=ext/etc/etc.c -->
@@ -661,13 +664,16 @@ module Etc
   #
   # name
   # :   contains the name of the group as a String.
+  #
   # passwd
   # :   contains the encrypted password as a String. An `'x'` is returned if
   #     password access to the group is not available; an empty string is returned
   #     if no password is needed to obtain membership of the group. This is
   #     system-dependent.
+  #
   # gid
   # :   contains the group's numeric ID as an integer.
+  #
   # mem
   # :   is an Array of Strings containing the short login names of the members of
   #     the group.
@@ -679,7 +685,7 @@ module Etc
 
     # <!--
     #   rdoc-file=ext/etc/etc.c
-    #   - Etc::Group.each { |group| block }   ->       obj
+    #   - Etc::Group.each { |group| block }   ->       Etc::Group
     #   - Etc::Group.each                          ->     Enumerator
     # -->
     # Iterates for each entry in the `/etc/group` file if a block is given.
@@ -688,7 +694,7 @@ module Etc
     #
     # The code block is passed a Group struct.
     #
-    # Example:
+    # **Example:**
     #
     #     require 'etc'
     #
@@ -733,16 +739,21 @@ module Etc
   #
   # name
   # :   contains the short login name of the user as a String.
+  #
   # passwd
   # :   contains the encrypted password of the user as a String. an `'x'` is
   #     returned if shadow passwords are in use. An `'*'` is returned if the user
   #     cannot log in using a password.
+  #
   # uid
   # :   contains the integer user ID (uid) of the user.
+  #
   # gid
   # :   contains the integer group ID (gid) of the user's primary group.
+  #
   # dir
   # :   contains the path to the home directory of the user as a String.
+  #
   # shell
   # :   contains the path to the login shell of the user as a String.
   #
@@ -753,16 +764,22 @@ module Etc
   # :   contains a longer String description of the user, such as a full name.
   #     Some Unix systems provide structured information in the gecos field, but
   #     this is system-dependent.
+  #
   # change
   # :   password change time(integer).
+  #
   # quota
   # :   quota value(integer).
+  #
   # age
   # :   password age(integer).
+  #
   # class
   # :   user access class(string).
+  #
   # comment
   # :   comment(string).
+  #
   # expire
   # :   account expiration time(integer).
   #
@@ -773,7 +790,7 @@ module Etc
 
     # <!--
     #   rdoc-file=ext/etc/etc.c
-    #   - Etc::Passwd.each { |struct| block }  ->  Passwd
+    #   - Etc::Passwd.each { |struct| block }  ->  Etc::Passwd
     #   - Etc::Passwd.each                     ->  Enumerator
     # -->
     # Iterates for each entry in the `/etc/passwd` file if a block is given.
@@ -784,7 +801,7 @@ module Etc
     #
     # See Etc.getpwent above for details.
     #
-    # Example:
+    # **Example:**
     #
     #     require 'etc'
     #