rbs 3.10.0 → 4.0.0.dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/comments.yml +3 -3
  3. data/.github/workflows/ruby.yml +24 -35
  4. data/.github/workflows/typecheck.yml +3 -1
  5. data/.github/workflows/windows.yml +2 -2
  6. data/.gitignore +0 -4
  7. data/CHANGELOG.md +0 -88
  8. data/README.md +1 -38
  9. data/Rakefile +20 -142
  10. data/Steepfile +1 -0
  11. data/config.yml +43 -1
  12. data/core/array.rbs +46 -100
  13. data/core/complex.rbs +21 -32
  14. data/core/dir.rbs +2 -2
  15. data/core/encoding.rbs +9 -6
  16. data/core/enumerable.rbs +3 -90
  17. data/core/enumerator.rbs +1 -18
  18. data/core/errno.rbs +0 -8
  19. data/core/errors.rbs +1 -28
  20. data/core/exception.rbs +2 -2
  21. data/core/fiber.rbs +4 -5
  22. data/core/file.rbs +12 -27
  23. data/core/file_test.rbs +1 -1
  24. data/core/float.rbs +22 -209
  25. data/core/gc.rbs +281 -417
  26. data/core/hash.rbs +727 -1024
  27. data/core/integer.rbs +38 -78
  28. data/core/io/buffer.rbs +7 -18
  29. data/core/io/wait.rbs +33 -11
  30. data/core/io.rbs +12 -14
  31. data/core/kernel.rbs +51 -57
  32. data/core/marshal.rbs +1 -1
  33. data/core/match_data.rbs +1 -1
  34. data/core/math.rbs +3 -42
  35. data/core/method.rbs +6 -14
  36. data/core/module.rbs +17 -88
  37. data/core/nil_class.rbs +3 -3
  38. data/core/numeric.rbs +16 -16
  39. data/core/object.rbs +3 -3
  40. data/core/object_space.rbs +15 -21
  41. data/core/proc.rbs +8 -15
  42. data/core/process.rbs +2 -2
  43. data/core/ractor.rbs +437 -278
  44. data/core/range.rbs +8 -7
  45. data/core/rational.rbs +24 -37
  46. data/core/rbs/unnamed/argf.rbs +2 -2
  47. data/core/rbs/unnamed/env_class.rbs +1 -1
  48. data/core/rbs/unnamed/random.rbs +2 -4
  49. data/core/regexp.rbs +20 -25
  50. data/core/ruby_vm.rbs +4 -6
  51. data/core/rubygems/errors.rbs +70 -3
  52. data/core/rubygems/rubygems.rbs +79 -11
  53. data/core/rubygems/version.rbs +3 -2
  54. data/core/set.rbs +359 -488
  55. data/core/string.rbs +1228 -3153
  56. data/core/struct.rbs +1 -1
  57. data/core/symbol.rbs +4 -4
  58. data/core/thread.rbs +29 -92
  59. data/core/time.rbs +9 -35
  60. data/core/trace_point.rbs +4 -7
  61. data/core/unbound_method.rbs +6 -14
  62. data/docs/collection.md +2 -2
  63. data/docs/gem.md +1 -0
  64. data/docs/sigs.md +3 -3
  65. data/ext/rbs_extension/ast_translation.c +1077 -944
  66. data/ext/rbs_extension/ast_translation.h +0 -7
  67. data/ext/rbs_extension/class_constants.c +83 -71
  68. data/ext/rbs_extension/class_constants.h +7 -4
  69. data/ext/rbs_extension/extconf.rb +2 -24
  70. data/ext/rbs_extension/legacy_location.c +172 -173
  71. data/ext/rbs_extension/legacy_location.h +3 -8
  72. data/ext/rbs_extension/main.c +289 -239
  73. data/ext/rbs_extension/rbs_extension.h +0 -3
  74. data/ext/rbs_extension/rbs_string_bridging.h +0 -4
  75. data/include/rbs/ast.h +98 -37
  76. data/include/rbs/defines.h +12 -38
  77. data/include/rbs/lexer.h +114 -126
  78. data/include/rbs/location.h +14 -14
  79. data/include/rbs/parser.h +37 -21
  80. data/include/rbs/string.h +5 -3
  81. data/include/rbs/util/rbs_allocator.h +19 -40
  82. data/include/rbs/util/rbs_assert.h +1 -12
  83. data/include/rbs/util/rbs_constant_pool.h +3 -3
  84. data/include/rbs/util/rbs_encoding.h +1 -3
  85. data/include/rbs/util/rbs_unescape.h +1 -2
  86. data/lib/rbs/ast/ruby/annotations.rb +119 -0
  87. data/lib/rbs/ast/ruby/comment_block.rb +221 -0
  88. data/lib/rbs/ast/ruby/declarations.rb +86 -0
  89. data/lib/rbs/ast/ruby/helpers/constant_helper.rb +24 -0
  90. data/lib/rbs/ast/ruby/helpers/location_helper.rb +15 -0
  91. data/lib/rbs/ast/ruby/members.rb +213 -0
  92. data/lib/rbs/buffer.rb +104 -24
  93. data/lib/rbs/cli/validate.rb +40 -35
  94. data/lib/rbs/cli.rb +5 -6
  95. data/lib/rbs/collection/config/lockfile_generator.rb +0 -1
  96. data/lib/rbs/collection.rb +0 -1
  97. data/lib/rbs/definition.rb +6 -1
  98. data/lib/rbs/definition_builder/ancestor_builder.rb +65 -62
  99. data/lib/rbs/definition_builder/method_builder.rb +45 -30
  100. data/lib/rbs/definition_builder.rb +44 -9
  101. data/lib/rbs/environment/class_entry.rb +69 -0
  102. data/lib/rbs/environment/module_entry.rb +66 -0
  103. data/lib/rbs/environment.rb +244 -218
  104. data/lib/rbs/environment_loader.rb +3 -3
  105. data/lib/rbs/errors.rb +5 -4
  106. data/lib/rbs/inline_parser/comment_association.rb +117 -0
  107. data/lib/rbs/inline_parser.rb +206 -0
  108. data/lib/rbs/location_aux.rb +35 -3
  109. data/lib/rbs/parser_aux.rb +11 -6
  110. data/lib/rbs/prototype/runtime.rb +2 -2
  111. data/lib/rbs/resolver/constant_resolver.rb +2 -2
  112. data/lib/rbs/resolver/type_name_resolver.rb +38 -124
  113. data/lib/rbs/source.rb +99 -0
  114. data/lib/rbs/subtractor.rb +4 -3
  115. data/lib/rbs/test/type_check.rb +0 -14
  116. data/lib/rbs/types.rb +1 -3
  117. data/lib/rbs/version.rb +1 -1
  118. data/lib/rbs.rb +13 -1
  119. data/lib/rdoc/discover.rb +1 -1
  120. data/lib/rdoc_plugin/parser.rb +1 -1
  121. data/rbs.gemspec +1 -0
  122. data/sig/ancestor_builder.rbs +1 -1
  123. data/sig/ast/ruby/annotations.rbs +110 -0
  124. data/sig/ast/ruby/comment_block.rbs +119 -0
  125. data/sig/ast/ruby/declarations.rbs +60 -0
  126. data/sig/ast/ruby/helpers/constant_helper.rbs +11 -0
  127. data/sig/ast/ruby/helpers/location_helper.rbs +15 -0
  128. data/sig/ast/ruby/members.rbs +72 -0
  129. data/sig/buffer.rbs +63 -5
  130. data/sig/definition.rbs +1 -0
  131. data/sig/definition_builder.rbs +1 -1
  132. data/sig/environment/class_entry.rbs +50 -0
  133. data/sig/environment/module_entry.rbs +50 -0
  134. data/sig/environment.rbs +28 -133
  135. data/sig/errors.rbs +13 -6
  136. data/sig/inline_parser/comment_association.rbs +71 -0
  137. data/sig/inline_parser.rbs +87 -0
  138. data/sig/location.rbs +32 -7
  139. data/sig/manifest.yaml +1 -0
  140. data/sig/method_builder.rbs +7 -4
  141. data/sig/parser.rbs +16 -20
  142. data/sig/resolver/type_name_resolver.rbs +7 -38
  143. data/sig/source.rbs +48 -0
  144. data/sig/types.rbs +1 -4
  145. data/src/ast.c +290 -201
  146. data/src/lexer.c +2813 -2902
  147. data/src/lexer.re +4 -0
  148. data/src/lexstate.c +155 -169
  149. data/src/location.c +40 -40
  150. data/src/parser.c +2665 -2433
  151. data/src/string.c +48 -0
  152. data/src/util/rbs_allocator.c +77 -80
  153. data/src/util/rbs_assert.c +10 -10
  154. data/src/util/rbs_buffer.c +2 -2
  155. data/src/util/rbs_constant_pool.c +15 -13
  156. data/src/util/rbs_encoding.c +4062 -20097
  157. data/src/util/rbs_unescape.c +48 -85
  158. data/stdlib/bigdecimal/0/big_decimal.rbs +82 -100
  159. data/stdlib/bigdecimal-math/0/big_math.rbs +8 -169
  160. data/stdlib/cgi/0/core.rbs +396 -2
  161. data/stdlib/cgi/0/manifest.yaml +0 -1
  162. data/stdlib/coverage/0/coverage.rbs +1 -3
  163. data/stdlib/date/0/date.rbs +59 -67
  164. data/stdlib/date/0/date_time.rbs +1 -1
  165. data/stdlib/delegate/0/delegator.rbs +7 -10
  166. data/stdlib/erb/0/erb.rbs +347 -737
  167. data/stdlib/fileutils/0/fileutils.rbs +13 -18
  168. data/stdlib/forwardable/0/forwardable.rbs +0 -3
  169. data/stdlib/json/0/json.rbs +48 -68
  170. data/stdlib/net-http/0/net-http.rbs +0 -3
  171. data/stdlib/objspace/0/objspace.rbs +4 -9
  172. data/stdlib/open-uri/0/open-uri.rbs +0 -40
  173. data/stdlib/openssl/0/openssl.rbs +228 -331
  174. data/stdlib/optparse/0/optparse.rbs +3 -3
  175. data/{core → stdlib/pathname/0}/pathname.rbs +355 -255
  176. data/stdlib/psych/0/psych.rbs +3 -3
  177. data/stdlib/rdoc/0/rdoc.rbs +1 -1
  178. data/stdlib/resolv/0/resolv.rbs +68 -25
  179. data/stdlib/ripper/0/ripper.rbs +2 -5
  180. data/stdlib/singleton/0/singleton.rbs +0 -3
  181. data/stdlib/socket/0/socket.rbs +1 -13
  182. data/stdlib/socket/0/tcp_socket.rbs +2 -10
  183. data/stdlib/stringio/0/stringio.rbs +85 -1176
  184. data/stdlib/strscan/0/string_scanner.rbs +31 -31
  185. data/stdlib/tempfile/0/tempfile.rbs +3 -3
  186. data/stdlib/time/0/time.rbs +1 -1
  187. data/stdlib/timeout/0/timeout.rbs +7 -63
  188. data/stdlib/tsort/0/cyclic.rbs +0 -3
  189. data/stdlib/uri/0/common.rbs +2 -11
  190. data/stdlib/uri/0/file.rbs +1 -1
  191. data/stdlib/uri/0/generic.rbs +16 -17
  192. data/stdlib/uri/0/rfc2396_parser.rbs +7 -6
  193. data/stdlib/zlib/0/zstream.rbs +0 -1
  194. metadata +40 -12
  195. data/.clang-format +0 -74
  196. data/.clangd +0 -2
  197. data/.github/workflows/c-check.yml +0 -54
  198. data/core/ruby.rbs +0 -53
  199. data/docs/aliases.md +0 -79
  200. data/docs/encoding.md +0 -56
  201. data/ext/rbs_extension/compat.h +0 -10
  202. data/stdlib/cgi-escape/0/escape.rbs +0 -153
data/core/array.rbs CHANGED
@@ -151,8 +151,8 @@
151
151
  #
152
152
  # ## Example Usage
153
153
  #
154
- # In addition to the methods it mixes in through the Enumerable module, class
155
- # Array has proprietary methods for accessing, searching and otherwise
154
+ # In addition to the methods it mixes in through the Enumerable module, the
155
+ # `Array` class has proprietary methods for accessing, searching and otherwise
156
156
  # manipulating arrays.
157
157
  #
158
158
  # Some of the more common ones are illustrated below.
@@ -200,9 +200,9 @@
200
200
  #
201
201
  # arr.drop(3) #=> [4, 5, 6]
202
202
  #
203
- # ## Obtaining Information about an Array
203
+ # ## Obtaining Information about an `Array`
204
204
  #
205
- # An array keeps track of its own length at all times. To query an array about
205
+ # Arrays keep track of their own length at all times. To query an array about
206
206
  # the number of elements it contains, use #length, #count or #size.
207
207
  #
208
208
  # browsers = ['Chrome', 'Firefox', 'Safari', 'Opera', 'IE']
@@ -217,7 +217,7 @@
217
217
  #
218
218
  # browsers.include?('Konqueror') #=> false
219
219
  #
220
- # ## Adding Items to an Array
220
+ # ## Adding Items to Arrays
221
221
  #
222
222
  # Items can be added to the end of an array by using either #push or #<<
223
223
  #
@@ -238,7 +238,7 @@
238
238
  # arr.insert(3, 'orange', 'pear', 'grapefruit')
239
239
  # #=> [0, 1, 2, "orange", "pear", "grapefruit", "apple", 3, 4, 5, 6]
240
240
  #
241
- # ## Removing Items from an Array
241
+ # ## Removing Items from an `Array`
242
242
  #
243
243
  # The method #pop removes the last element in an array and returns it:
244
244
  #
@@ -277,12 +277,12 @@
277
277
  # arr = [2, 5, 6, 556, 6, 6, 8, 9, 0, 123, 556]
278
278
  # arr.uniq #=> [2, 5, 6, 556, 8, 9, 0, 123]
279
279
  #
280
- # ## Iterating over an Array
280
+ # ## Iterating over Arrays
281
281
  #
282
- # Like all classes that include the Enumerable module, class Array has an each
282
+ # Like all classes that include the Enumerable module, `Array` has an each
283
283
  # method, which defines what elements should be iterated over and how. In case
284
- # of Array#each, all elements in `self` are yielded to the supplied block in
285
- # sequence.
284
+ # of Array's #each, all elements in the `Array` instance are yielded to the
285
+ # supplied block in sequence.
286
286
  #
287
287
  # Note that this operation leaves the array unchanged.
288
288
  #
@@ -307,7 +307,7 @@
307
307
  # arr.map! {|a| a**2} #=> [1, 4, 9, 16, 25]
308
308
  # arr #=> [1, 4, 9, 16, 25]
309
309
  #
310
- # ## Selecting Items from an Array
310
+ # ## Selecting Items from an `Array`
311
311
  #
312
312
  # Elements can be selected from an array according to criteria defined in a
313
313
  # block. The selection can happen in a destructive or a non-destructive manner.
@@ -340,13 +340,13 @@
340
340
  #
341
341
  # ## What's Here
342
342
  #
343
- # First, what's elsewhere. Class Array:
343
+ # First, what's elsewhere. Class `Array`:
344
344
  #
345
345
  # * Inherits from [class Object](rdoc-ref:Object@What-27s+Here).
346
346
  # * Includes [module Enumerable](rdoc-ref:Enumerable@What-27s+Here), which
347
347
  # provides dozens of additional methods.
348
348
  #
349
- # Here, class Array provides methods that are useful for:
349
+ # Here, class `Array` provides methods that are useful for:
350
350
  #
351
351
  # * [Creating an Array](rdoc-ref:Array@Methods+for+Creating+an+Array)
352
352
  # * [Querying](rdoc-ref:Array@Methods+for+Querying)
@@ -359,7 +359,7 @@
359
359
  # * [Converting](rdoc-ref:Array@Methods+for+Converting)
360
360
  # * [And more....](rdoc-ref:Array@Other+Methods)
361
361
  #
362
- # ### Methods for Creating an Array
362
+ # ### Methods for Creating an `Array`
363
363
  #
364
364
  # * ::[]: Returns a new array populated with given objects.
365
365
  # * ::new: Returns a new array.
@@ -524,7 +524,7 @@
524
524
  # return-value.
525
525
  # * #flatten: Returns an array that is a recursive flattening of `self`.
526
526
  # * #inspect (aliased as #to_s): Returns a new String containing the elements.
527
- # * #join: Returns a new String containing the elements joined by the field
527
+ # * #join: Returns a newsString containing the elements joined by the field
528
528
  # separator.
529
529
  # * #to_a: Returns `self` or a new array containing all elements.
530
530
  # * #to_ary: Returns `self`.
@@ -840,8 +840,9 @@ class Array[unchecked out Elem] < Object
840
840
  #
841
841
  # If `index` is out of range, returns `nil`.
842
842
  #
843
- # When two Integer arguments `start` and `length` are given, returns a new array
844
- # of size `length` containing successive elements beginning at offset `start`:
843
+ # When two Integer arguments `start` and `length` are given, returns a new
844
+ # `Array` of size `length` containing successive elements beginning at offset
845
+ # `start`:
845
846
  #
846
847
  # a = [:foo, 'bar', 2]
847
848
  # a[0, 2] # => [:foo, "bar"]
@@ -855,7 +856,7 @@ class Array[unchecked out Elem] < Object
855
856
  # a[1, 3] # => ["bar", 2]
856
857
  # a[2, 2] # => [2]
857
858
  #
858
- # If `start == self.size` and `length >= 0`, returns a new empty array.
859
+ # If `start == self.size` and `length >= 0`, returns a new empty `Array`.
859
860
  #
860
861
  # If `length` is negative, returns `nil`.
861
862
  #
@@ -866,7 +867,7 @@ class Array[unchecked out Elem] < Object
866
867
  # a[0..1] # => [:foo, "bar"]
867
868
  # a[1..2] # => ["bar", 2]
868
869
  #
869
- # Special case: If `range.start == a.size`, returns a new empty array.
870
+ # Special case: If `range.start == a.size`, returns a new empty `Array`.
870
871
  #
871
872
  # If `range.end` is negative, calculates the end index from the end:
872
873
  #
@@ -890,7 +891,7 @@ class Array[unchecked out Elem] < Object
890
891
  # a[4..-1] # => nil
891
892
  #
892
893
  # When a single Enumerator::ArithmeticSequence argument `aseq` is given, returns
893
- # an array of elements corresponding to the indexes produced by the sequence.
894
+ # an `Array` of elements corresponding to the indexes produced by the sequence.
894
895
  #
895
896
  # a = ['--', 'data1', '--', 'data2', '--', 'data3']
896
897
  # a[(1..).step(2)] # => ["data1", "data2", "data3"]
@@ -975,8 +976,8 @@ class Array[unchecked out Elem] < Object
975
976
  # a # => [:foo, "bar", "two"]
976
977
  #
977
978
  # When Integer arguments `start` and `length` are given and `object` is not an
978
- # array, removes `length - 1` elements beginning at offset `start`, and assigns
979
- # `object` at offset `start`:
979
+ # `Array`, removes `length - 1` elements beginning at offset `start`, and
980
+ # assigns `object` at offset `start`:
980
981
  #
981
982
  # a = [:foo, 'bar', 2]
982
983
  # a[0, 2] = 'foo' # => "foo"
@@ -1009,7 +1010,7 @@ class Array[unchecked out Elem] < Object
1009
1010
  # a[1, 5] = 'foo' # => "foo"
1010
1011
  # a # => [:foo, "foo"]
1011
1012
  #
1012
- # When Range argument `range` is given and `object` is not an array, removes
1013
+ # When Range argument `range` is given and `object` is not an `Array`, removes
1013
1014
  # `length - 1` elements beginning at offset `start`, and assigns `object` at
1014
1015
  # offset `start`:
1015
1016
  #
@@ -1213,7 +1214,7 @@ class Array[unchecked out Elem] < Object
1213
1214
  # Returns the element from `self` found by a binary search, or `nil` if the
1214
1215
  # search found no suitable element.
1215
1216
  #
1216
- # See [Binary Searching](rdoc-ref:language/bsearch.rdoc).
1217
+ # See [Binary Searching](rdoc-ref:bsearch.rdoc).
1217
1218
  #
1218
1219
  # Related: see [Methods for Fetching](rdoc-ref:Array@Methods+for+Fetching).
1219
1220
  #
@@ -1229,7 +1230,7 @@ class Array[unchecked out Elem] < Object
1229
1230
  # Returns the integer index of the element from `self` found by a binary search,
1230
1231
  # or `nil` if the search found no suitable element.
1231
1232
  #
1232
- # See [Binary Searching](rdoc-ref:language/bsearch.rdoc).
1233
+ # See [Binary Searching](rdoc-ref:bsearch.rdoc).
1233
1234
  #
1234
1235
  # Related: see [Methods for Fetching](rdoc-ref:Array@Methods+for+Fetching).
1235
1236
  #
@@ -1273,9 +1274,9 @@ class Array[unchecked out Elem] < Object
1273
1274
 
1274
1275
  # <!--
1275
1276
  # rdoc-file=array.c
1276
- # - collect! {|element| ... } -> self
1277
+ # - collect! {|element| ... } -> new_array
1277
1278
  # - collect! -> new_enumerator
1278
- # - map! {|element| ... } -> self
1279
+ # - map! {|element| ... } -> new_array
1279
1280
  # - map! -> new_enumerator
1280
1281
  # -->
1281
1282
  # With a block given, calls the block with each element of `self` and replaces
@@ -1563,7 +1564,7 @@ class Array[unchecked out Elem] < Object
1563
1564
 
1564
1565
  # <!--
1565
1566
  # rdoc-file=array.c
1566
- # - dig(index, *identifiers) -> object
1567
+ # - array.dig(index, *identifiers) -> object
1567
1568
  # -->
1568
1569
  # Finds and returns the object in nested object specified by `index` and
1569
1570
  # `identifiers`; the nested objects may be instances of various classes. See
@@ -1692,7 +1693,7 @@ class Array[unchecked out Elem] < Object
1692
1693
 
1693
1694
  # <!--
1694
1695
  # rdoc-file=array.c
1695
- # - empty? -> true or false
1696
+ # - array.empty? -> true or false
1696
1697
  # -->
1697
1698
  # Returns `true` if the count of elements in `self` is zero, `false` otherwise.
1698
1699
  #
@@ -1803,10 +1804,10 @@ class Array[unchecked out Elem] < Object
1803
1804
 
1804
1805
  # <!--
1805
1806
  # rdoc-file=array.c
1806
- # - fill(object, start = nil, count = nil) -> self
1807
- # - fill(object, range) -> self
1808
- # - fill(start = nil, count = nil) {|element| ... } -> self
1809
- # - fill(range) {|element| ... } -> self
1807
+ # - fill(object, start = nil, count = nil) -> new_array
1808
+ # - fill(object, range) -> new_array
1809
+ # - fill(start = nil, count = nil) {|element| ... } -> new_array
1810
+ # - fill(range) {|element| ... } -> new_array
1810
1811
  # -->
1811
1812
  # Replaces selected elements in `self`; may add elements to `self`; always
1812
1813
  # returns `self` (never a new array).
@@ -2019,32 +2020,6 @@ class Array[unchecked out Elem] < Object
2019
2020
  def filter!: () { (Elem item) -> boolish } -> self?
2020
2021
  | () -> ::Enumerator[Elem, self?]
2021
2022
 
2022
- # <!--
2023
- # rdoc-file=array.c
2024
- # - find(if_none_proc = nil) {|element| ... } -> object or nil
2025
- # - find(if_none_proc = nil) -> enumerator
2026
- # -->
2027
- # Returns the first element for which the block returns a truthy value.
2028
- #
2029
- # With a block given, calls the block with successive elements of the array;
2030
- # returns the first element for which the block returns a truthy value:
2031
- #
2032
- # (0..9).find {|element| element > 2} # => 3
2033
- #
2034
- # If no such element is found, calls `if_none_proc` and returns its return
2035
- # value.
2036
- #
2037
- # (0..9).find(proc {false}) {|element| element > 12} # => false
2038
- # {foo: 0, bar: 1, baz: 2}.find {|key, value| key.start_with?('b') } # => [:bar, 1]
2039
- # {foo: 0, bar: 1, baz: 2}.find(proc {[]}) {|key, value| key.start_with?('c') } # => []
2040
- #
2041
- # With no block given, returns an Enumerator.
2042
- #
2043
- def find: () { (Elem) -> boolish } -> Elem?
2044
- | () -> ::Enumerator[Elem, Elem?]
2045
- | [T] (Enumerable::_NotFound[T] ifnone) { (Elem) -> boolish } -> (Elem | T)
2046
- | [T] (Enumerable::_NotFound[T] ifnone) -> ::Enumerator[Elem, Elem | T]
2047
-
2048
2023
  # <!--
2049
2024
  # rdoc-file=array.c
2050
2025
  # - find_index(object) -> integer or nil
@@ -2325,7 +2300,7 @@ class Array[unchecked out Elem] < Object
2325
2300
 
2326
2301
  # <!--
2327
2302
  # rdoc-file=array.c
2328
- # - join(separator = $,) -> new_string
2303
+ # - array.join(separator = $,) -> new_string
2329
2304
  # -->
2330
2305
  # Returns the new string formed by joining the converted elements of `self`; for
2331
2306
  # each element `element`:
@@ -2644,7 +2619,7 @@ class Array[unchecked out Elem] < Object
2644
2619
  # - pack(template, buffer: nil) -> string
2645
2620
  # -->
2646
2621
  # Formats each element in `self` into a binary string; returns that string. See
2647
- # [Packed Data](rdoc-ref:language/packed_data.rdoc).
2622
+ # [Packed Data](rdoc-ref:packed_data.rdoc).
2648
2623
  #
2649
2624
  def pack: (string fmt, ?buffer: String?) -> String
2650
2625
 
@@ -3014,33 +2989,6 @@ class Array[unchecked out Elem] < Object
3014
2989
  def reverse_each: () { (Elem item) -> void } -> self
3015
2990
  | () -> ::Enumerator[Elem, self]
3016
2991
 
3017
- # <!--
3018
- # rdoc-file=array.c
3019
- # - rfind(if_none_proc = nil) {|element| ... } -> object or nil
3020
- # - rfind(if_none_proc = nil) -> enumerator
3021
- # -->
3022
- # Returns the last element for which the block returns a truthy value.
3023
- #
3024
- # With a block given, calls the block with successive elements of the array in
3025
- # reverse order; returns the last element for which the block returns a truthy
3026
- # value:
3027
- #
3028
- # (0..9).rfind {|element| element < 5} # => 4
3029
- #
3030
- # If no such element is found, calls `if_none_proc` and returns its return
3031
- # value.
3032
- #
3033
- # (0..9).rfind(proc {false}) {|element| element < -2} # => false
3034
- # {foo: 0, bar: 1, baz: 2}.rfind {|key, value| key.start_with?('b') } # => [:baz, 2]
3035
- # {foo: 0, bar: 1, baz: 2}.rfind(proc {[]}) {|key, value| key.start_with?('c') } # => []
3036
- #
3037
- # With no block given, returns an Enumerator.
3038
- #
3039
- def rfind: () { (Elem) -> boolish } -> Elem?
3040
- | () -> ::Enumerator[Elem, Elem?]
3041
- | [T] (Enumerable::_NotFound[T] ifnone) { (Elem) -> boolish } -> (Elem | T)
3042
- | [T] (Enumerable::_NotFound[T] ifnone) -> ::Enumerator[Elem, Elem | T]
3043
-
3044
2992
  # <!--
3045
2993
  # rdoc-file=array.c
3046
2994
  # - rindex(object) -> integer or nil
@@ -3167,7 +3115,7 @@ class Array[unchecked out Elem] < Object
3167
3115
  #
3168
3116
  # The order of the result array is unrelated to the order of `self`.
3169
3117
  #
3170
- # Returns a new empty array if `self` is empty:
3118
+ # Returns a new empty `Array` if `self` is empty:
3171
3119
  #
3172
3120
  # [].sample(4) # => []
3173
3121
  #
@@ -3372,8 +3320,9 @@ class Array[unchecked out Elem] < Object
3372
3320
  #
3373
3321
  # If `index` is out of range, returns `nil`.
3374
3322
  #
3375
- # When two Integer arguments `start` and `length` are given, returns a new array
3376
- # of size `length` containing successive elements beginning at offset `start`:
3323
+ # When two Integer arguments `start` and `length` are given, returns a new
3324
+ # `Array` of size `length` containing successive elements beginning at offset
3325
+ # `start`:
3377
3326
  #
3378
3327
  # a = [:foo, 'bar', 2]
3379
3328
  # a[0, 2] # => [:foo, "bar"]
@@ -3387,7 +3336,7 @@ class Array[unchecked out Elem] < Object
3387
3336
  # a[1, 3] # => ["bar", 2]
3388
3337
  # a[2, 2] # => [2]
3389
3338
  #
3390
- # If `start == self.size` and `length >= 0`, returns a new empty array.
3339
+ # If `start == self.size` and `length >= 0`, returns a new empty `Array`.
3391
3340
  #
3392
3341
  # If `length` is negative, returns `nil`.
3393
3342
  #
@@ -3398,7 +3347,7 @@ class Array[unchecked out Elem] < Object
3398
3347
  # a[0..1] # => [:foo, "bar"]
3399
3348
  # a[1..2] # => ["bar", 2]
3400
3349
  #
3401
- # Special case: If `range.start == a.size`, returns a new empty array.
3350
+ # Special case: If `range.start == a.size`, returns a new empty `Array`.
3402
3351
  #
3403
3352
  # If `range.end` is negative, calculates the end index from the end:
3404
3353
  #
@@ -3422,7 +3371,7 @@ class Array[unchecked out Elem] < Object
3422
3371
  # a[4..-1] # => nil
3423
3372
  #
3424
3373
  # When a single Enumerator::ArithmeticSequence argument `aseq` is given, returns
3425
- # an array of elements corresponding to the indexes produced by the sequence.
3374
+ # an `Array` of elements corresponding to the indexes produced by the sequence.
3426
3375
  #
3427
3376
  # a = ['--', 'data1', '--', 'data2', '--', 'data3']
3428
3377
  # a[(1..).step(2)] # => ["data1", "data2", "data3"]
@@ -3569,9 +3518,6 @@ class Array[unchecked out Elem] < Object
3569
3518
  # When the block returns zero, the order for `a` and `b` is indeterminate, and
3570
3519
  # may be unstable.
3571
3520
  #
3572
- # See an example in Numeric#nonzero? for the idiom to sort more complex
3573
- # structure.
3574
- #
3575
3521
  # Related: see [Methods for Fetching](rdoc-ref:Array@Methods+for+Fetching).
3576
3522
  #
3577
3523
  def sort: () -> ::Array[Elem]
@@ -3701,7 +3647,7 @@ class Array[unchecked out Elem] < Object
3701
3647
  # rdoc-file=array.c
3702
3648
  # - to_a -> self or new_array
3703
3649
  # -->
3704
- # When `self` is an instance of Array, returns `self`.
3650
+ # When `self` is an instance of `Array`, returns `self`.
3705
3651
  #
3706
3652
  # Otherwise, returns a new array containing the elements of `self`:
3707
3653
  #
@@ -3717,7 +3663,7 @@ class Array[unchecked out Elem] < Object
3717
3663
 
3718
3664
  # <!--
3719
3665
  # rdoc-file=array.c
3720
- # - to_ary -> self
3666
+ # - array.to_ary -> self
3721
3667
  # -->
3722
3668
  # Returns `self`.
3723
3669
  #
@@ -4062,7 +4008,7 @@ class Array[unchecked out Elem] < Object
4062
4008
  # [:c3, :b3, :a3]]
4063
4009
  #
4064
4010
  # For an **object** in **other_arrays** that is not actually an array, forms the
4065
- # "other array" as `object.to_ary`, if defined, or as `object.each.to_a`
4011
+ # the "other array" as `object.to_ary`, if defined, or as `object.each.to_a`
4066
4012
  # otherwise.
4067
4013
  #
4068
4014
  # Related: see [Methods for Converting](rdoc-ref:Array@Methods+for+Converting).
data/core/complex.rbs CHANGED
@@ -184,24 +184,23 @@ class Complex < Numeric
184
184
 
185
185
  # <!--
186
186
  # rdoc-file=complex.c
187
- # - self * other -> numeric
187
+ # - complex * numeric -> new_complex
188
188
  # -->
189
- # Returns the numeric product of `self` and `other`:
189
+ # Returns the product of `self` and `numeric`:
190
190
  #
191
- # Complex.rect(9, 8) * 4 # => (36+32i)
192
- # Complex.rect(20, 9) * 9.8 # => (196.0+88.2i)
193
191
  # Complex.rect(2, 3) * Complex.rect(2, 3) # => (-5+12i)
194
192
  # Complex.rect(900) * Complex.rect(1) # => (900+0i)
195
193
  # Complex.rect(-2, 9) * Complex.rect(-9, 2) # => (0-85i)
196
- # Complex.rect(9, 8) * Rational(2, 3) # => ((6/1)+(16/3)*i)
194
+ # Complex.rect(9, 8) * 4 # => (36+32i)
195
+ # Complex.rect(20, 9) * 9.8 # => (196.0+88.2i)
197
196
  #
198
197
  def *: (Numeric) -> Complex
199
198
 
200
199
  # <!--
201
200
  # rdoc-file=complex.c
202
- # - self ** exponent -> complex
201
+ # - complex ** numeric -> new_complex
203
202
  # -->
204
- # Returns `self` raised to the power `exponent`:
203
+ # Returns `self` raised to power `numeric`:
205
204
  #
206
205
  # Complex.rect(0, 1) ** 2 # => (-1+0i)
207
206
  # Complex.rect(-8) ** Rational(1, 3) # => (1.0000000000000002+1.7320508075688772i)
@@ -210,25 +209,15 @@ class Complex < Numeric
210
209
 
211
210
  # <!--
212
211
  # rdoc-file=complex.c
213
- # - self + other -> numeric
212
+ # - complex + numeric -> new_complex
214
213
  # -->
215
- # Returns the sum of `self` and `other`:
216
- #
217
- # Complex(1, 2) + 0 # => (1+2i)
218
- # Complex(1, 2) + 1 # => (2+2i)
219
- # Complex(1, 2) + -1 # => (0+2i)
220
- #
221
- # Complex(1, 2) + 1.0 # => (2.0+2i)
222
- #
223
- # Complex(1, 2) + Complex(2, 1) # => (3+3i)
224
- # Complex(1, 2) + Complex(2.0, 1.0) # => (3.0+3.0i)
225
- #
226
- # Complex(1, 2) + Rational(1, 1) # => ((2/1)+2i)
227
- # Complex(1, 2) + Rational(1, 2) # => ((3/2)+2i)
228
- #
229
- # For a computation involving Floats, the result may be inexact (see Float#+):
214
+ # Returns the sum of `self` and `numeric`:
230
215
  #
231
- # Complex(1, 2) + 3.14 # => (4.140000000000001+2i)
216
+ # Complex.rect(2, 3) + Complex.rect(2, 3) # => (4+6i)
217
+ # Complex.rect(900) + Complex.rect(1) # => (901+0i)
218
+ # Complex.rect(-2, 9) + Complex.rect(-9, 2) # => (-11+11i)
219
+ # Complex.rect(9, 8) + 4 # => (13+8i)
220
+ # Complex.rect(20, 9) + 9.8 # => (29.8+9i)
232
221
  #
233
222
  def +: (Numeric) -> Complex
234
223
 
@@ -236,9 +225,9 @@ class Complex < Numeric
236
225
 
237
226
  # <!--
238
227
  # rdoc-file=complex.c
239
- # - self - other -> complex
228
+ # - complex - numeric -> new_complex
240
229
  # -->
241
- # Returns the difference of `self` and `other`:
230
+ # Returns the difference of `self` and `numeric`:
242
231
  #
243
232
  # Complex.rect(2, 3) - Complex.rect(2, 3) # => (0+0i)
244
233
  # Complex.rect(900) - Complex.rect(1) # => (899+0i)
@@ -250,9 +239,9 @@ class Complex < Numeric
250
239
 
251
240
  # <!--
252
241
  # rdoc-file=complex.c
253
- # - -self -> complex
242
+ # - -complex -> new_complex
254
243
  # -->
255
- # Returns `self`, negated, which is the negation of each of its parts:
244
+ # Returns the negation of `self`, which is the negation of each of its parts:
256
245
  #
257
246
  # -Complex.rect(1, 2) # => (-1-2i)
258
247
  # -Complex.rect(-1, -2) # => (1+2i)
@@ -261,9 +250,9 @@ class Complex < Numeric
261
250
 
262
251
  # <!--
263
252
  # rdoc-file=complex.c
264
- # - self / other -> complex
253
+ # - complex / numeric -> new_complex
265
254
  # -->
266
- # Returns the quotient of `self` and `other`:
255
+ # Returns the quotient of `self` and `numeric`:
267
256
  #
268
257
  # Complex.rect(2, 3) / Complex.rect(2, 3) # => (1+0i)
269
258
  # Complex.rect(900) / Complex.rect(1) # => (900+0i)
@@ -605,9 +594,9 @@ class Complex < Numeric
605
594
 
606
595
  # <!--
607
596
  # rdoc-file=complex.c
608
- # - self / other -> complex
597
+ # - complex / numeric -> new_complex
609
598
  # -->
610
- # Returns the quotient of `self` and `other`:
599
+ # Returns the quotient of `self` and `numeric`:
611
600
  #
612
601
  # Complex.rect(2, 3) / Complex.rect(2, 3) # => (1+0i)
613
602
  # Complex.rect(900) / Complex.rect(1) # => (900+0i)
data/core/dir.rbs CHANGED
@@ -477,8 +477,8 @@ class Dir
477
477
 
478
478
  # <!--
479
479
  # rdoc-file=dir.rb
480
- # - Dir.glob(patterns, flags: 0, base: nil, sort: true) -> array
481
- # - Dir.glob(patterns, flags: 0, base: nil, sort: true) {|entry_name| ... } -> nil
480
+ # - Dir.glob(*patterns, flags: 0, base: nil, sort: true) -> array
481
+ # - Dir.glob(*patterns, flags: 0, base: nil, sort: true) {|entry_name| ... } -> nil
482
482
  # -->
483
483
  # Forms an array *entry_names* of the entry names selected by the arguments.
484
484
  #
data/core/encoding.rbs CHANGED
@@ -281,7 +281,7 @@ class Encoding
281
281
  def inspect: () -> String
282
282
 
283
283
  # <!-- rdoc-file=encoding.c -->
284
- # The name of the encoding.
284
+ # Returns the name of the encoding.
285
285
  #
286
286
  # Encoding::UTF_8.name #=> "UTF-8"
287
287
  #
@@ -297,8 +297,12 @@ class Encoding
297
297
  #
298
298
  def names: () -> Array[String]
299
299
 
300
- # <!-- rdoc-file=encoding.c -->
301
- # The name of the encoding.
300
+ # <!--
301
+ # rdoc-file=encoding.c
302
+ # - enc.name -> string
303
+ # - enc.to_s -> string
304
+ # -->
305
+ # Returns the name of the encoding.
302
306
  #
303
307
  # Encoding::UTF_8.name #=> "UTF-8"
304
308
  #
@@ -919,9 +923,8 @@ class Encoding::Converter < Object
919
923
  # p ec.primitive_convert(src, dst, nil, 1) #=> :destination_buffer_full
920
924
  # p ec.last_error #=> nil
921
925
  #
922
- def last_error: () -> ( Encoding::InvalidByteSequenceError
923
- | Encoding::UndefinedConversionError
924
- | nil )
926
+ def last_error: () -> Encoding::InvalidByteSequenceError?
927
+ | () -> Encoding::UndefinedConversionError?
925
928
 
926
929
  # <!--
927
930
  # rdoc-file=transcode.c
data/core/enumerable.rbs CHANGED
@@ -114,8 +114,8 @@
114
114
  # by the block.
115
115
  # * #grep: Returns elements selected by a given object or objects returned by
116
116
  # a given block.
117
- # * #grep_v: Returns elements not selected by a given object or objects
118
- # returned by a given block.
117
+ # * #grep_v: Returns elements selected by a given object or objects returned
118
+ # by a given block.
119
119
  # * #inject (aliased as #reduce): Returns the object formed by combining all
120
120
  # elements.
121
121
  # * #sum: Returns the sum of the elements, using method `+`.
@@ -191,82 +191,6 @@
191
191
  # usage would not make sense, and so it is not shown. Example: #tally would
192
192
  # find exactly one of each Hash entry.
193
193
  #
194
- # ## Extended Methods
195
- #
196
- # A Enumerable class may define extended methods. This section describes the
197
- # standard behavior of extension methods for reference purposes.
198
- #
199
- # ### #size
200
- #
201
- # Enumerator has a #size method. It uses the size function argument passed to
202
- # `Enumerator.new`.
203
- #
204
- # e = Enumerator.new(-> { 3 }) {|y| p y; y.yield :a; y.yield :b; y.yield :c; :z }
205
- # p e.size #=> 3
206
- # p e.next #=> :a
207
- # p e.next #=> :b
208
- # p e.next #=> :c
209
- # begin
210
- # e.next
211
- # rescue StopIteration
212
- # p $!.result #=> :z
213
- # end
214
- #
215
- # The result of the size function should represent the number of iterations
216
- # (i.e., the number of times Enumerator::Yielder#yield is called). In the above
217
- # example, the block calls #yield three times, and the size function, +-> { 3
218
- # }+, returns 3 accordingly. The result of the size function can be an integer,
219
- # `Float::INFINITY`, or `nil`. An integer means the exact number of times #yield
220
- # will be called, as shown above. `Float::INFINITY` indicates an infinite number
221
- # of #yield calls. `nil` means the number of #yield calls is difficult or
222
- # impossible to determine.
223
- #
224
- # Many iteration methods return an Enumerator object with an appropriate size
225
- # function if no block is given.
226
- #
227
- # Examples:
228
- #
229
- # ["a", "b", "c"].each.size #=> 3
230
- # {a: "x", b: "y", c: "z"}.each.size #=> 3
231
- # (0..20).to_a.permutation.size #=> 51090942171709440000
232
- # loop.size #=> Float::INFINITY
233
- # (1..100).drop_while.size #=> nil # size depends on the block's behavior
234
- # STDIN.each.size #=> nil # cannot be computed without consuming input
235
- # File.open("/etc/resolv.conf").each.size #=> nil # cannot be computed without reading the file
236
- #
237
- # The behavior of #size for Range-based enumerators depends on the #begin
238
- # element:
239
- #
240
- # * If the #begin element is an Integer, the #size method returns an Integer
241
- # or `Float::INFINITY`.
242
- # * If the #begin element is an object with a #succ method (other than
243
- # Integer), #size returns `nil`. (Computing the size would require
244
- # repeatedly calling #succ, which may be too slow.)
245
- # * If the #begin element does not have a #succ method, #size raises a
246
- # TypeError.
247
- #
248
- # Examples:
249
- #
250
- # (10..42).each.size #=> 33
251
- # (10..42.9).each.size #=> 33 (the #end element may be a non-integer numeric)
252
- # (10..).each.size #=> Float::INFINITY
253
- # ("a".."z").each.size #=> nil
254
- # ("a"..).each.size #=> nil
255
- # (1.0..9.0).each.size # raises TypeError (Float does not have #succ)
256
- # (..10).each.size # raises TypeError (beginless range has nil as its #begin)
257
- #
258
- # The Enumerable module itself does not define a #size method. A class that
259
- # includes Enumerable may define its own #size method. It is recommended that
260
- # such a #size method be consistent with Enumerator#size.
261
- #
262
- # Array and Hash implement #size and return values consistent with
263
- # Enumerator#size. IO and Dir do not define #size, which is also consistent
264
- # because the corresponding enumerator's size function returns `nil`.
265
- #
266
- # However, it is not strictly required for a class's #size method to match
267
- # Enumerator#size. For example, File#size returns the number of bytes in the
268
- # file, not the number of lines.
269
- #
270
194
  module Enumerable[unchecked out Elem] : _Each[Elem]
271
195
  # <!--
272
196
  # rdoc-file=enum.c
@@ -514,17 +438,6 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
514
438
  #
515
439
  # With no block given, returns an Enumerator.
516
440
  #
517
- # e = (1..4).drop_while
518
- # p e #=> #<Enumerator: 1..4:drop_while>
519
- # i = e.next; p i; e.feed(i < 3) #=> 1
520
- # i = e.next; p i; e.feed(i < 3) #=> 2
521
- # i = e.next; p i; e.feed(i < 3) #=> 3
522
- # begin
523
- # e.next
524
- # rescue StopIteration
525
- # p $!.result #=> [3, 4]
526
- # end
527
- #
528
441
  def drop_while: () { (Elem) -> boolish } -> ::Array[Elem]
529
442
  | () -> ::Enumerator[Elem, ::Array[Elem]]
530
443
 
@@ -2127,7 +2040,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
2127
2040
  # ["F", 6860]
2128
2041
  #
2129
2042
  # You can use the special symbol `:_alone` to force an element into its own
2130
- # separate chunk:
2043
+ # separate chuck:
2131
2044
  #
2132
2045
  # a = [0, 0, 1, 1]
2133
2046
  # e = a.chunk{|i| i.even? ? :_alone : true }