rbs 4.0.0.dev.5 → 4.0.1.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 (194) hide show
  1. checksums.yaml +4 -4
  2. data/.clang-format +1 -0
  3. data/.github/workflows/c-check.yml +8 -4
  4. data/.github/workflows/comments.yml +3 -1
  5. data/.github/workflows/dependabot.yml +1 -1
  6. data/.github/workflows/ruby.yml +10 -0
  7. data/.github/workflows/rust.yml +95 -0
  8. data/CHANGELOG.md +323 -0
  9. data/Rakefile +12 -29
  10. data/Steepfile +1 -0
  11. data/config.yml +393 -37
  12. data/core/array.rbs +218 -188
  13. data/core/basic_object.rbs +9 -8
  14. data/core/class.rbs +6 -5
  15. data/core/comparable.rbs +45 -31
  16. data/core/complex.rbs +52 -40
  17. data/core/dir.rbs +57 -45
  18. data/core/encoding.rbs +5 -5
  19. data/core/enumerable.rbs +96 -91
  20. data/core/enumerator.rbs +4 -3
  21. data/core/errno.rbs +3 -2
  22. data/core/errors.rbs +31 -29
  23. data/core/exception.rbs +12 -12
  24. data/core/fiber.rbs +36 -36
  25. data/core/file.rbs +186 -113
  26. data/core/file_test.rbs +2 -2
  27. data/core/float.rbs +41 -32
  28. data/core/gc.rbs +78 -70
  29. data/core/hash.rbs +70 -60
  30. data/core/integer.rbs +32 -28
  31. data/core/io/buffer.rbs +36 -36
  32. data/core/io/wait.rbs +7 -7
  33. data/core/io.rbs +120 -135
  34. data/core/kernel.rbs +189 -139
  35. data/core/marshal.rbs +3 -3
  36. data/core/match_data.rbs +14 -12
  37. data/core/math.rbs +69 -67
  38. data/core/method.rbs +6 -6
  39. data/core/module.rbs +146 -85
  40. data/core/nil_class.rbs +4 -3
  41. data/core/numeric.rbs +35 -32
  42. data/core/object.rbs +6 -8
  43. data/core/object_space.rbs +11 -10
  44. data/core/pathname.rbs +131 -81
  45. data/core/proc.rbs +65 -33
  46. data/core/process.rbs +219 -201
  47. data/core/ractor.rbs +15 -11
  48. data/core/random.rbs +4 -3
  49. data/core/range.rbs +52 -47
  50. data/core/rational.rbs +5 -5
  51. data/core/rbs/unnamed/argf.rbs +58 -51
  52. data/core/rbs/unnamed/env_class.rbs +18 -13
  53. data/core/rbs/unnamed/main_class.rbs +123 -0
  54. data/core/rbs/unnamed/random.rbs +7 -5
  55. data/core/regexp.rbs +236 -197
  56. data/core/ruby.rbs +1 -1
  57. data/core/ruby_vm.rbs +32 -30
  58. data/core/rubygems/config_file.rbs +5 -5
  59. data/core/rubygems/errors.rbs +1 -1
  60. data/core/rubygems/requirement.rbs +5 -5
  61. data/core/rubygems/rubygems.rbs +5 -3
  62. data/core/set.rbs +17 -16
  63. data/core/signal.rbs +2 -2
  64. data/core/string.rbs +311 -292
  65. data/core/struct.rbs +26 -25
  66. data/core/symbol.rbs +25 -24
  67. data/core/thread.rbs +40 -34
  68. data/core/time.rbs +47 -42
  69. data/core/trace_point.rbs +34 -31
  70. data/core/true_class.rbs +2 -2
  71. data/core/unbound_method.rbs +10 -10
  72. data/core/warning.rbs +7 -7
  73. data/docs/collection.md +1 -1
  74. data/docs/config.md +171 -0
  75. data/docs/inline.md +110 -4
  76. data/docs/syntax.md +13 -12
  77. data/ext/rbs_extension/ast_translation.c +489 -135
  78. data/ext/rbs_extension/class_constants.c +8 -0
  79. data/ext/rbs_extension/class_constants.h +4 -0
  80. data/ext/rbs_extension/legacy_location.c +28 -51
  81. data/ext/rbs_extension/legacy_location.h +37 -0
  82. data/ext/rbs_extension/main.c +12 -20
  83. data/include/rbs/ast.h +423 -195
  84. data/include/rbs/lexer.h +2 -2
  85. data/include/rbs/location.h +25 -44
  86. data/include/rbs/parser.h +2 -2
  87. data/include/rbs/util/rbs_constant_pool.h +0 -3
  88. data/include/rbs.h +8 -0
  89. data/lib/rbs/ast/ruby/annotations.rb +157 -4
  90. data/lib/rbs/ast/ruby/members.rb +374 -22
  91. data/lib/rbs/cli/validate.rb +5 -60
  92. data/lib/rbs/collection/config/lockfile_generator.rb +6 -2
  93. data/lib/rbs/definition_builder.rb +60 -27
  94. data/lib/rbs/errors.rb +0 -11
  95. data/lib/rbs/inline_parser.rb +1 -1
  96. data/lib/rbs/parser_aux.rb +20 -7
  97. data/lib/rbs/prototype/helpers.rb +57 -0
  98. data/lib/rbs/prototype/rb.rb +1 -26
  99. data/lib/rbs/prototype/rbi.rb +1 -20
  100. data/lib/rbs/test/type_check.rb +3 -0
  101. data/lib/rbs/types.rb +62 -52
  102. data/lib/rbs/unit_test/type_assertions.rb +35 -8
  103. data/lib/rbs/version.rb +1 -1
  104. data/lib/rbs.rb +0 -1
  105. data/rbs.gemspec +1 -1
  106. data/rust/.gitignore +1 -0
  107. data/rust/Cargo.lock +378 -0
  108. data/rust/Cargo.toml +7 -0
  109. data/rust/ruby-rbs/Cargo.toml +22 -0
  110. data/rust/ruby-rbs/build.rs +764 -0
  111. data/rust/ruby-rbs/examples/locations.rs +60 -0
  112. data/rust/ruby-rbs/src/lib.rs +1 -0
  113. data/rust/ruby-rbs/src/node/mod.rs +742 -0
  114. data/rust/ruby-rbs/tests/sanity.rs +47 -0
  115. data/rust/ruby-rbs/vendor/rbs/config.yml +1 -0
  116. data/rust/ruby-rbs-sys/Cargo.toml +23 -0
  117. data/rust/ruby-rbs-sys/build.rs +204 -0
  118. data/rust/ruby-rbs-sys/src/lib.rs +50 -0
  119. data/rust/ruby-rbs-sys/vendor/rbs/include +1 -0
  120. data/rust/ruby-rbs-sys/vendor/rbs/src +1 -0
  121. data/rust/ruby-rbs-sys/wrapper.h +1 -0
  122. data/sig/ast/ruby/annotations.rbs +191 -4
  123. data/sig/ast/ruby/members.rbs +21 -1
  124. data/sig/cli/validate.rbs +1 -6
  125. data/sig/definition_builder.rbs +2 -0
  126. data/sig/errors.rbs +0 -8
  127. data/sig/method_types.rbs +1 -1
  128. data/sig/parser.rbs +17 -13
  129. data/sig/prototype/helpers.rbs +2 -0
  130. data/sig/types.rbs +10 -11
  131. data/sig/unit_test/spy.rbs +0 -8
  132. data/sig/unit_test/type_assertions.rbs +11 -0
  133. data/src/ast.c +339 -161
  134. data/src/lexstate.c +1 -1
  135. data/src/location.c +7 -47
  136. data/src/parser.c +674 -480
  137. data/src/util/rbs_constant_pool.c +0 -4
  138. data/stdlib/bigdecimal/0/big_decimal.rbs +16 -16
  139. data/stdlib/cgi-escape/0/escape.rbs +4 -4
  140. data/stdlib/coverage/0/coverage.rbs +4 -3
  141. data/stdlib/date/0/date.rbs +33 -28
  142. data/stdlib/date/0/date_time.rbs +24 -23
  143. data/stdlib/did_you_mean/0/did_you_mean.rbs +17 -16
  144. data/stdlib/erb/0/erb.rbs +64 -53
  145. data/stdlib/etc/0/etc.rbs +55 -50
  146. data/stdlib/fileutils/0/fileutils.rbs +138 -125
  147. data/stdlib/forwardable/0/forwardable.rbs +10 -10
  148. data/stdlib/io-console/0/io-console.rbs +2 -2
  149. data/stdlib/json/0/json.rbs +135 -108
  150. data/stdlib/monitor/0/monitor.rbs +3 -3
  151. data/stdlib/net-http/0/net-http.rbs +159 -134
  152. data/stdlib/objspace/0/objspace.rbs +8 -7
  153. data/stdlib/open-uri/0/open-uri.rbs +8 -8
  154. data/stdlib/open3/0/open3.rbs +36 -35
  155. data/stdlib/openssl/0/openssl.rbs +144 -129
  156. data/stdlib/optparse/0/optparse.rbs +18 -14
  157. data/stdlib/pathname/0/pathname.rbs +2 -2
  158. data/stdlib/pp/0/pp.rbs +9 -8
  159. data/stdlib/prettyprint/0/prettyprint.rbs +7 -7
  160. data/stdlib/pstore/0/pstore.rbs +35 -30
  161. data/stdlib/psych/0/psych.rbs +61 -8
  162. data/stdlib/psych/0/store.rbs +2 -4
  163. data/stdlib/pty/0/pty.rbs +9 -6
  164. data/stdlib/random-formatter/0/random-formatter.rbs +2 -2
  165. data/stdlib/ripper/0/ripper.rbs +20 -17
  166. data/stdlib/securerandom/0/securerandom.rbs +1 -1
  167. data/stdlib/shellwords/0/shellwords.rbs +2 -2
  168. data/stdlib/socket/0/addrinfo.rbs +7 -7
  169. data/stdlib/socket/0/basic_socket.rbs +3 -3
  170. data/stdlib/socket/0/ip_socket.rbs +10 -8
  171. data/stdlib/socket/0/socket.rbs +10 -9
  172. data/stdlib/socket/0/tcp_server.rbs +1 -1
  173. data/stdlib/socket/0/tcp_socket.rbs +1 -1
  174. data/stdlib/socket/0/udp_socket.rbs +1 -1
  175. data/stdlib/socket/0/unix_server.rbs +1 -1
  176. data/stdlib/stringio/0/stringio.rbs +55 -54
  177. data/stdlib/strscan/0/string_scanner.rbs +46 -44
  178. data/stdlib/tempfile/0/tempfile.rbs +24 -20
  179. data/stdlib/time/0/time.rbs +7 -5
  180. data/stdlib/tsort/0/tsort.rbs +7 -6
  181. data/stdlib/uri/0/common.rbs +26 -18
  182. data/stdlib/uri/0/file.rbs +2 -2
  183. data/stdlib/uri/0/generic.rbs +2 -2
  184. data/stdlib/uri/0/http.rbs +2 -2
  185. data/stdlib/uri/0/ldap.rbs +2 -2
  186. data/stdlib/uri/0/mailto.rbs +3 -3
  187. data/stdlib/uri/0/rfc2396_parser.rbs +6 -5
  188. data/stdlib/zlib/0/deflate.rbs +4 -3
  189. data/stdlib/zlib/0/gzip_reader.rbs +4 -4
  190. data/stdlib/zlib/0/gzip_writer.rbs +14 -12
  191. data/stdlib/zlib/0/inflate.rbs +1 -1
  192. data/stdlib/zlib/0/need_dict.rbs +1 -1
  193. metadata +23 -5
  194. data/.github/workflows/valgrind.yml +0 -42
@@ -1,6 +1,7 @@
1
1
  # <!-- rdoc-file=ext/strscan/strscan.c -->
2
2
  # Class `StringScanner` supports processing a stored string as a stream;
3
- # this code creates a new `StringScanner` object with string `'foobarbaz'`:
3
+ # this code creates a new `StringScanner` object with string
4
+ # <code>'foobarbaz'</code>:
4
5
  # require 'strscan'
5
6
  # scanner = StringScanner.new('foobarbaz')
6
7
  #
@@ -19,13 +20,13 @@
19
20
  # ENGLISH_TEXT = 'Hello'
20
21
  #
21
22
  # Some examples here assume that certain helper methods are defined:
22
- # * `put_situation(scanner)`:
23
+ # * <code>put_situation(scanner)</code>:
23
24
  # Displays the values of the scanner's
24
25
  # methods #pos, #charpos, #rest, and #rest_size.
25
- # * `put_match_values(scanner)`:
26
+ # * <code>put_match_values(scanner)</code>:
26
27
  # Displays the scanner's [match
27
28
  # values](rdoc-ref:StringScanner@Match+Values).
28
- # * `match_values_cleared?(scanner)`:
29
+ # * <code>match_values_cleared?(scanner)</code>:
29
30
  # Returns whether the scanner's [match
30
31
  # values](rdoc-ref:StringScanner@Match+Values) are cleared.
31
32
  # See examples at [helper methods](helper_methods.md).
@@ -45,7 +46,7 @@
45
46
  # The scanner has:
46
47
  # * A *stored string*, which is:
47
48
  # * Initially set by StringScanner.new(string) to the given `string`
48
- # (`'foobarbaz'` in the example above).
49
+ # (<code>'foobarbaz'</code> in the example above).
49
50
  # * Modifiable by methods #string=(new_string) and #concat(more_string).
50
51
  # * Returned by method #string.
51
52
  # More at [Stored String](rdoc-ref:StringScanner@Stored+String) below.
@@ -63,7 +64,7 @@
63
64
  # which is a trailing substring of the stored string;
64
65
  # it extends from the current position to the end of the stored string:
65
66
  # * Initially set by StringScanner.new(string) to the given `string`
66
- # (`'foobarbaz'` in the example above).
67
+ # (<code>'foobarbaz'</code> in the example above).
67
68
  # * Returned by method #rest.
68
69
  # * Modified by any modification to either the stored string or the
69
70
  # position.
@@ -96,7 +97,7 @@
96
97
  # When the byte position is:
97
98
  # * Zero (at the beginning), the target substring is the entire stored string.
98
99
  # * Equal to the size of the stored string (at the end),
99
- # the target substring is the empty string `''`.
100
+ # the target substring is the empty string <code>''</code>.
100
101
  # To get or set the byte position:
101
102
  # * #pos: returns the byte position.
102
103
  # * #pos=(new_pos): sets the byte position.
@@ -120,7 +121,7 @@
120
121
  # * #charpos: the [character
121
122
  # position](rdoc-ref:StringScanner@Character+Position).
122
123
  # * #rest: the [target substring](rdoc-ref:StringScanner@Target+Substring).
123
- # * #rest_size: `rest.size`.
124
+ # * #rest_size: <code>rest.size</code>.
124
125
  # ### Character Position
125
126
  # The character position is a zero-based index into the *characters*
126
127
  # in the stored string;
@@ -211,12 +212,12 @@
211
212
  # This table summarizes (details and examples at the links):
212
213
  # Method | Returns |Sets Match Values?
213
214
  # ---------------------|---------------------------------------------|------------------
214
- # #check(pattern) | Matched leading substring or `nil`. | Yes.
215
- # #check_until(pattern)| Matched substring (anywhere) or `nil`. | Yes.
215
+ # #check(pattern) | Matched leading substring or +nil+. | Yes.
216
+ # #check_until(pattern)| Matched substring (anywhere) or +nil+. | Yes.
216
217
  # #exist?(pattern) | Matched substring (anywhere) end index. | Yes.
217
- # #match?(pattern) | Size of matched leading substring or `nil`. | Yes.
218
+ # #match?(pattern) | Size of matched leading substring or +nil+. | Yes.
218
219
  # #peek(size) | Leading substring of given length (bytes). | No.
219
- # #peek_byte | Integer leading byte or `nil`. | No.
220
+ # #peek_byte | Integer leading byte or +nil+. | No.
220
221
  # #rest |Target substring (from byte position to end).| No.
221
222
  # ### Traversing the Target Substring
222
223
  # A *traversal* method examines the target substring,
@@ -226,24 +227,24 @@
226
227
  # This table summarizes (details and examples at links):
227
228
  # Method | Returns |Sets Match Values?
228
229
  # --------------------|----------------------------------------------------|------------------
229
- # #get_byte | Leading byte or `nil`. | No.
230
- # #getch | Leading character or `nil`. | No.
231
- # #scan(pattern) | Matched leading substring or `nil`. | Yes.
232
- # #scan_byte | Integer leading byte or `nil`. | No.
233
- # #scan_until(pattern)| Matched substring (anywhere) or `nil`. | Yes.
234
- # #skip(pattern) | Matched leading substring size or `nil`. | Yes.
235
- # #skip_until(pattern)|Position delta to end-of-matched-substring or `nil`.| Yes.
236
- # #unscan | `self`. | No.
230
+ # #get_byte | Leading byte or +nil+. | No.
231
+ # #getch | Leading character or +nil+. | No.
232
+ # #scan(pattern) | Matched leading substring or +nil+. | Yes.
233
+ # #scan_byte | Integer leading byte or +nil+. | No.
234
+ # #scan_until(pattern)| Matched substring (anywhere) or +nil+. | Yes.
235
+ # #skip(pattern) | Matched leading substring size or +nil+. | Yes.
236
+ # #skip_until(pattern)|Position delta to end-of-matched-substring or +nil+.| Yes.
237
+ # #unscan | +self+. | No.
237
238
  # ## Querying the Scanner
238
239
  # Each of these methods queries the scanner object
239
240
  # without modifying it (details and examples at links)
240
241
  # Method | Returns
241
242
  # -------------------|--------------------------------
242
- # #beginning_of_line?| `true` or `false`.
243
+ # #beginning_of_line?| +true+ or +false+.
243
244
  # #charpos | Character position.
244
- # #eos? | `true` or `false`.
245
- # #fixed_anchor? | `true` or `false`.
246
- # #inspect |String representation of `self`.
245
+ # #eos? | +true+ or +false+.
246
+ # #fixed_anchor? | +true+ or +false+.
247
+ # #inspect |String representation of +self+.
247
248
  # #pos | Byte position.
248
249
  # #rest | Target substring.
249
250
  # #rest_size | Size of target substring.
@@ -290,7 +291,7 @@
290
291
  # generally contain the results of the most recent attempted match.
291
292
  # Each match value may be thought of as:
292
293
  # * *Clear*: Initially, or after an unsuccessful match attempt:
293
- # usually, `false`, `nil`, or `{}`.
294
+ # usually, `false`, `nil`, or <code>{}</code>.
294
295
  # * *Set*: After a successful match attempt:
295
296
  # `true`, string, array, or hash.
296
297
  # Each of these methods clears match values:
@@ -312,11 +313,11 @@
312
313
  # Each of these methods returns a basic match value:
313
314
  # Method | Return After Match |Return After No Match
314
315
  # -------------|--------------------------------------|---------------------
315
- # #matched? | `true`. | `false`.
316
- # #matched_size| Size of matched substring. | `nil`.
317
- # #matched | Matched substring. | `nil`.
318
- # #pre_match |Substring preceding matched substring.| `nil`.
319
- # #post_match |Substring following matched substring.| `nil`.
316
+ # #matched? | +true+. | +false+.
317
+ # #matched_size| Size of matched substring. | +nil+.
318
+ # #matched | Matched substring. | +nil+.
319
+ # #pre_match |Substring preceding matched substring.| +nil+.
320
+ # #post_match |Substring following matched substring.| +nil+.
320
321
  #
321
322
  # See examples below.
322
323
  # #### Captured Match Values
@@ -326,11 +327,11 @@
326
327
  # Each of these methods returns a captured match value:
327
328
  # Method | Return After Match |Return After No Match
328
329
  # ---------------|---------------------------------------|---------------------
329
- # #size | Count of captured substrings. | `nil`.
330
- # #[](n) | `n`th captured substring. | `nil`.
331
- # #captures | Array of all captured substrings. | `nil`.
332
- # #values_at(*n) |Array of specified captured substrings.| `nil`.
333
- # #named_captures| Hash of named captures. | `{}`.
330
+ # #size | Count of captured substrings. | +nil+.
331
+ # #[](n) | `n`th captured substring. | +nil+.
332
+ # #captures | Array of all captured substrings. | +nil+.
333
+ # #values_at(*n) |Array of specified captured substrings.| +nil+.
334
+ # #named_captures| Hash of named captures. | <code>{}</code>.
334
335
  #
335
336
  # See examples below.
336
337
  # #### Match Values Examples
@@ -401,7 +402,7 @@
401
402
  # ## Fixed-Anchor Property
402
403
  # Pattern matching in `StringScanner` is the same as in Ruby's,
403
404
  # except for its fixed-anchor property,
404
- # which determines the meaning of `'\A'`:
405
+ # which determines the meaning of <code>'\A'</code>:
405
406
  # * `false` (the default): matches the current byte position.
406
407
  # scanner = StringScanner.new('foobar')
407
408
  # scanner.scan(/\A./) # => "f"
@@ -486,13 +487,13 @@ class StringScanner
486
487
  # scanner[:day] # => "12"
487
488
  # scanner[:nope] # => nil
488
489
  #
489
- # When there are no captures, only `[0]` returns non-`nil`:
490
+ # When there are no captures, only <code>[0]</code> returns non-`nil`:
490
491
  # scanner = StringScanner.new('foobarbaz')
491
492
  # scanner.exist?(/bar/)
492
493
  # scanner[0] # => "bar"
493
494
  # scanner[1] # => nil
494
495
  #
495
- # For a failed match, even `[0]` returns `nil`:
496
+ # For a failed match, even <code>[0]</code> returns `nil`:
496
497
  # scanner.scan(/nope/) # => nil
497
498
  # scanner[0] # => nil
498
499
  # scanner[1] # => nil
@@ -539,7 +540,8 @@ class StringScanner
539
540
  # - captures -> substring_array or nil
540
541
  # -->
541
542
  # Returns the array of [captured match
542
- # values](rdoc-ref:StringScanner@Captured+Match+Values) at indexes `(1..)`
543
+ # values](rdoc-ref:StringScanner@Captured+Match+Values) at indexes
544
+ # <code>(1..)</code>
543
545
  # if the most recent match attempt succeeded, or `nil` otherwise:
544
546
  # scanner = StringScanner.new('Fri Dec 12 1975 14:39')
545
547
  # scanner.captures # => nil
@@ -999,7 +1001,7 @@ class StringScanner
999
1001
  # rdoc-file=ext/strscan/strscan.c
1000
1002
  # - peek(length) -> substring
1001
1003
  # -->
1002
- # Returns the substring `string[pos, length]`;
1004
+ # Returns the substring <code>string[pos, length]</code>;
1003
1005
  # does not update [match values](rdoc-ref:StringScanner@Match+Values) or
1004
1006
  # [positions](rdoc-ref:StringScanner@Positions):
1005
1007
  # scanner = StringScanner.new('foobarbaz')
@@ -1151,7 +1153,7 @@ class StringScanner
1151
1153
  # Sets both [byte position](rdoc-ref:StringScanner@Byte+Position+-28Position-29)
1152
1154
  # and [character position](rdoc-ref:StringScanner@Character+Position) to zero,
1153
1155
  # and clears [match values](rdoc-ref:StringScanner@Match+Values);
1154
- # returns `self`:
1156
+ # returns +self+:
1155
1157
  # scanner = StringScanner.new('foobarbaz')
1156
1158
  # scanner.exist?(/bar/) # => 6
1157
1159
  # scanner.reset # => #<StringScanner 0/9 @ "fooba...">
@@ -1237,7 +1239,7 @@ class StringScanner
1237
1239
  # * Returns the matched substring.
1238
1240
  # * Increments the [byte
1239
1241
  # position](rdoc-ref:StringScanner@Byte+Position+-28Position-29) by
1240
- # `substring.bytesize`,
1242
+ # <code>substring.bytesize</code>,
1241
1243
  # and may increment the [character
1242
1244
  # position](rdoc-ref:StringScanner@Character+Position).
1243
1245
  # * Sets [match values](rdoc-ref:StringScanner@Match+Values).
@@ -1517,7 +1519,7 @@ class StringScanner
1517
1519
  # call-seq:
1518
1520
  # terminate -> self
1519
1521
  # Sets the scanner to end-of-string;
1520
- # returns `self`:
1522
+ # returns +self+:
1521
1523
  # * Sets both [positions](rdoc-ref:StringScanner@Positions) to end-of-stream.
1522
1524
  # * Clears [match values](rdoc-ref:StringScanner@Match+Values).
1523
1525
  # scanner = StringScanner.new(HIRAGANA_TEXT)
@@ -1578,7 +1580,7 @@ class StringScanner
1578
1580
  # - values_at(*specifiers) -> array_of_captures or nil
1579
1581
  # -->
1580
1582
  # Returns an array of captured substrings, or `nil` of none.
1581
- # For each `specifier`, the returned substring is `[specifier]`;
1583
+ # For each `specifier`, the returned substring is <code>[specifier]</code>;
1582
1584
  # see #[].
1583
1585
  # scanner = StringScanner.new('Fri Dec 12 1975 14:39')
1584
1586
  # pattern = /(?<wday>\w+) (?<month>\w+) (?<day>\d+) /
@@ -159,7 +159,7 @@ class Tempfile < File
159
159
  # * Generated filename is unique in that directory.
160
160
  # * Permissions are `0600`; see [File
161
161
  # Permissions](rdoc-ref:File@File+Permissions).
162
- # * Mode is `'w+'` (read/write mode, positioned at the end).
162
+ # * Mode is <code>'w+'</code> (read/write mode, positioned at the end).
163
163
  #
164
164
  # The temporary file removal depends on the keyword argument `anonymous` and
165
165
  # whether a block is given or not. See the description about the `anonymous`
@@ -206,8 +206,8 @@ class Tempfile < File
206
206
  #
207
207
  # Tempfile.create('foo') # => #<File:/tmp/foo20220505-9795-1gok8l9>
208
208
  #
209
- # * An array of two strings `[prefix, suffix]`: the generated filename begins
210
- # with `prefix` and ends with `suffix`:
209
+ # * An array of two strings <code>[prefix, suffix]</code>: the generated
210
+ # filename begins with `prefix` and ends with `suffix`:
211
211
  #
212
212
  # Tempfile.create(%w/foo .jpg/) # => #<File:/tmp/foo20220505-17839-tnjchh.jpg>
213
213
  #
@@ -226,16 +226,19 @@ class Tempfile < File
226
226
  #
227
227
  # The keyword argument `anonymous` specifies when the file is removed.
228
228
  #
229
- # * `anonymous=false` (default) without a block: the file is not removed.
230
- # * `anonymous=false` (default) with a block: the file is removed after the
231
- # block exits.
232
- # * `anonymous=true` without a block: the file is removed before returning.
233
- # * `anonymous=true` with a block: the file is removed before the block is
234
- # called.
229
+ # * <code>anonymous=false</code> (default) without a block: the file is not
230
+ # removed.
231
+ # * <code>anonymous=false</code> (default) with a block: the file is removed
232
+ # after the block exits.
233
+ # * <code>anonymous=true</code> without a block: the file is removed before
234
+ # returning.
235
+ # * <code>anonymous=true</code> with a block: the file is removed before the
236
+ # block is called.
235
237
  #
236
- # In the first case (`anonymous=false` without a block), the file is not removed
237
- # automatically. It should be explicitly closed. It can be used to rename to the
238
- # desired filename. If the file is not needed, it should be explicitly removed.
238
+ # In the first case (<code>anonymous=false</code> without a block), the file is
239
+ # not removed automatically. It should be explicitly closed. It can be used to
240
+ # rename to the desired filename. If the file is not needed, it should be
241
+ # explicitly removed.
239
242
  #
240
243
  # The File#path method of the created file object returns the temporary
241
244
  # directory with a trailing slash when `anonymous` is true.
@@ -248,8 +251,8 @@ class Tempfile < File
248
251
  #
249
252
  # Implementation note:
250
253
  #
251
- # The keyword argument `anonymous=true` is implemented using `FILE_SHARE_DELETE`
252
- # on Windows. `O_TMPFILE` is used on Linux.
254
+ # The keyword argument <code>anonymous=true</code> is implemented using
255
+ # `FILE_SHARE_DELETE` on Windows. `O_TMPFILE` is used on Linux.
253
256
  #
254
257
  # Related: Tempfile.new.
255
258
  #
@@ -283,7 +286,8 @@ class Tempfile < File
283
286
  #
284
287
  # The call returns the value of the block.
285
288
  #
286
- # In any case, all arguments (`*args`) will be passed to Tempfile.new.
289
+ # In any case, all arguments (<code>*args</code>) will be passed to
290
+ # Tempfile.new.
287
291
  #
288
292
  # Tempfile.open('foo', '/home/temp') do |f|
289
293
  # # ... do something with f ...
@@ -318,7 +322,7 @@ class Tempfile < File
318
322
  # - close!()
319
323
  # -->
320
324
  # Closes and unlinks (deletes) the file. Has the same effect as called
321
- # `close(true)`.
325
+ # <code>close(true)</code>.
322
326
  #
323
327
  def close!: () -> void
324
328
 
@@ -422,7 +426,7 @@ class Tempfile < File
422
426
  # If possible, consider instead using Tempfile.create, which:
423
427
  #
424
428
  # * Avoids the performance cost of delegation, incurred when Tempfile.new
425
- # calls its superclass `DelegateClass(File)`.
429
+ # calls its superclass <code>DelegateClass(File)</code>.
426
430
  # * Does not rely on a finalizer to close and unlink the file, which can be
427
431
  # unreliable.
428
432
  #
@@ -433,7 +437,7 @@ class Tempfile < File
433
437
  # * Generated filename is unique in that directory.
434
438
  # * Permissions are `0600`; see [File
435
439
  # Permissions](rdoc-ref:File@File+Permissions).
436
- # * Mode is `'w+'` (read/write mode, positioned at the end).
440
+ # * Mode is <code>'w+'</code> (read/write mode, positioned at the end).
437
441
  #
438
442
  # The underlying file is removed when the Tempfile object dies and is reclaimed
439
443
  # by the garbage collector.
@@ -454,8 +458,8 @@ class Tempfile < File
454
458
  #
455
459
  # Tempfile.new('foo') # => #<Tempfile:/tmp/foo20220505-17839-1whk2f>
456
460
  #
457
- # * An array of two strings `[prefix, suffix]`: the generated filename begins
458
- # with `prefix` and ends with `suffix`:
461
+ # * An array of two strings <code>[prefix, suffix]</code>: the generated
462
+ # filename begins with `prefix` and ends with `suffix`:
459
463
  #
460
464
  # Tempfile.new(%w/foo .jpg/) # => #<Tempfile:/tmp/foo20220505-17839-58xtfi.jpg>
461
465
  #
@@ -14,8 +14,9 @@ class Time
14
14
  # -->
15
15
  # Return the number of seconds the specified time zone differs from UTC.
16
16
  #
17
- # Numeric time zones that include minutes, such as `-10:00` or `+1330` will
18
- # work, as will simpler hour-only time zones like `-10` or `+13`.
17
+ # Numeric time zones that include minutes, such as <code>-10:00</code> or
18
+ # <code>+1330</code> will work, as will simpler hour-only time zones like
19
+ # <code>-10</code> or <code>+13</code>.
19
20
  #
20
21
  # Textual time zones listed in ZoneOffset are also supported.
21
22
  #
@@ -120,9 +121,10 @@ class Time
120
121
  # Based on this fact, this method only understands the time zone abbreviations
121
122
  # described in RFC 822 and the system time zone, in the order named. (i.e. a
122
123
  # definition in RFC 822 overrides the system time zone definition.) The system
123
- # time zone is taken from `Time.local(year, 1, 1).zone` and `Time.local(year, 7,
124
- # 1).zone`. If the extracted time zone abbreviation does not match any of them,
125
- # it is ignored and the given time is regarded as a local time.
124
+ # time zone is taken from <code>Time.local(year, 1, 1).zone</code> and
125
+ # <code>Time.local(year, 7, 1).zone</code>. If the extracted time zone
126
+ # abbreviation does not match any of them, it is ignored and the given time is
127
+ # regarded as a local time.
126
128
  #
127
129
  # ArgumentError is raised if Date._parse cannot extract information from `date`
128
130
  # or if the Time class cannot represent specified date.
@@ -262,9 +262,9 @@ module TSort[Node] : TSort::_Sortable[Node]
262
262
  # - each_strongly_connected_component() { |nodes| ... }
263
263
  # -->
264
264
  # The iterator version of the #strongly_connected_components method.
265
- # *`obj*.each_strongly_connected_component` is similar to
266
- # *`obj*.strongly_connected_components.each`, but modification of *obj* during
267
- # the iteration may lead to unexpected results.
265
+ # <code><em>obj</em>.each_strongly_connected_component</code> is similar to
266
+ # <code><em>obj</em>.strongly_connected_components.each</code>, but modification
267
+ # of *obj* during the iteration may lead to unexpected results.
268
268
  #
269
269
  # #each_strongly_connected_component returns `nil`.
270
270
  #
@@ -382,9 +382,10 @@ module TSort[Node] : TSort::_Sortable[Node]
382
382
  # rdoc-file=lib/tsort.rb
383
383
  # - tsort_each() { |node| ... }
384
384
  # -->
385
- # The iterator version of the #tsort method. *`obj*.tsort_each` is similar to
386
- # *`obj*.tsort.each`, but modification of *obj* during the iteration may lead to
387
- # unexpected results.
385
+ # The iterator version of the #tsort method.
386
+ # <code><em>obj</em>.tsort_each</code> is similar to
387
+ # <code><em>obj</em>.tsort.each</code>, but modification of *obj* during the
388
+ # iteration may lead to unexpected results.
388
389
  #
389
390
  # #tsort_each returns `nil`. If there is a cycle, TSort::Cyclic is raised.
390
391
  #
@@ -119,7 +119,7 @@ module URI
119
119
  # rdoc-file=lib/uri/common.rb
120
120
  # - decode_uri_component(str, enc=Encoding::UTF_8)
121
121
  # -->
122
- # Like URI.decode_www_form_component, except that `'+'` is preserved.
122
+ # Like URI.decode_www_form_component, except that <code>'+'</code> is preserved.
123
123
  #
124
124
  def self.decode_uri_component: (String str, ?encoding enc) -> String
125
125
 
@@ -131,7 +131,8 @@ module URI
131
131
  # ASCII string.
132
132
  #
133
133
  # The method may be used to decode the body of Net::HTTPResponse object `res`
134
- # for which `res['Content-Type']` is `'application/x-www-form-urlencoded'`.
134
+ # for which <code>res['Content-Type']</code> is
135
+ # <code>'application/x-www-form-urlencoded'</code>.
135
136
  #
136
137
  # The returned data is an array of 2-element subarrays; each subarray is a
137
138
  # name/value pair (both are strings). Each returned string has encoding `enc`,
@@ -175,8 +176,10 @@ module URI
175
176
  #
176
177
  # * Preserves:
177
178
  #
178
- # * Characters `'*'`, `'.'`, `'-'`, and `'_'`.
179
- # * Character in ranges `'a'..'z'`, `'A'..'Z'`, and `'0'..'9'`.
179
+ # * Characters <code>'*'</code>, <code>'.'</code>, <code>'-'</code>, and
180
+ # <code>'_'</code>.
181
+ # * Character in ranges <code>'a'..'z'</code>, <code>'A'..'Z'</code>, and
182
+ # <code>'0'..'9'</code>.
180
183
  #
181
184
  # Example:
182
185
  #
@@ -185,7 +188,7 @@ module URI
185
188
  #
186
189
  # * Converts:
187
190
  #
188
- # * Character `'+'` to character `' '`.
191
+ # * Character <code>'+'</code> to character <code>' '</code>.
189
192
  # * Each "percent notation" to an ASCII character.
190
193
  #
191
194
  # Example:
@@ -193,7 +196,7 @@ module URI
193
196
  # URI.decode_www_form_component('Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A')
194
197
  # # => "Here are some punctuation characters: ,;?:"
195
198
  #
196
- # Related: URI.decode_uri_component (preserves `'+'`).
199
+ # Related: URI.decode_uri_component (preserves <code>'+'</code>).
197
200
  #
198
201
  def self.decode_www_form_component: (String str, ?encoding enc) -> String
199
202
 
@@ -201,8 +204,8 @@ module URI
201
204
  # rdoc-file=lib/uri/common.rb
202
205
  # - encode_uri_component(str, enc=nil)
203
206
  # -->
204
- # Like URI.encode_www_form_component, except that `' '` (space) is encoded as
205
- # `'%20'` (instead of `'+'`).
207
+ # Like URI.encode_www_form_component, except that <code>' '</code> (space) is
208
+ # encoded as <code>'%20'</code> (instead of <code>'+'</code>).
206
209
  #
207
210
  def self.encode_uri_component: (String str, ?encoding enc) -> String
208
211
 
@@ -214,10 +217,10 @@ module URI
214
217
  # [Enumerable](rdoc-ref:Enumerable@Enumerable+in+Ruby+Classes) `enum`.
215
218
  #
216
219
  # The result is suitable for use as form data for an HTTP request whose
217
- # `Content-Type` is `'application/x-www-form-urlencoded'`.
220
+ # <code>Content-Type</code> is <code>'application/x-www-form-urlencoded'</code>.
218
221
  #
219
222
  # The returned string consists of the elements of `enum`, each converted to one
220
- # or more URL-encoded strings, and all joined with character `'&'`.
223
+ # or more URL-encoded strings, and all joined with character <code>'&'</code>.
221
224
  #
222
225
  # Simple examples:
223
226
  #
@@ -248,7 +251,8 @@ module URI
248
251
  # URI.encode_www_form([['foo', 0], ['bar', :baz, 'bat']])
249
252
  # # => "foo=0&bar=baz"
250
253
  #
251
- # * If `ele` is an array of one element, the field is formed from `ele[0]`:
254
+ # * If `ele` is an array of one element, the field is formed from
255
+ # <code>ele[0]</code>:
252
256
  #
253
257
  # URI.encode_www_form_component(ele[0])
254
258
  #
@@ -316,8 +320,10 @@ module URI
316
320
  #
317
321
  # * Preserves:
318
322
  #
319
- # * Characters `'*'`, `'.'`, `'-'`, and `'_'`.
320
- # * Character in ranges `'a'..'z'`, `'A'..'Z'`, and `'0'..'9'`.
323
+ # * Characters <code>'*'</code>, <code>'.'</code>, <code>'-'</code>, and
324
+ # <code>'_'</code>.
325
+ # * Character in ranges <code>'a'..'z'</code>, <code>'A'..'Z'</code>, and
326
+ # <code>'0'..'9'</code>.
321
327
  #
322
328
  # Example:
323
329
  #
@@ -326,9 +332,9 @@ module URI
326
332
  #
327
333
  # * Converts:
328
334
  #
329
- # * Character `' '` to character `'+'`.
335
+ # * Character <code>' '</code> to character <code>'+'</code>.
330
336
  # * Any other character to "percent notation"; the percent notation for
331
- # character *c* is `'%%%X' % c.ord`.
337
+ # character *c* is <code>'%%%X' % c.ord</code>.
332
338
  #
333
339
  # Example:
334
340
  #
@@ -343,7 +349,8 @@ module URI
343
349
  #
344
350
  # In either case, the returned string has forced encoding Encoding::US_ASCII.
345
351
  #
346
- # Related: URI.encode_uri_component (encodes `' '` as `'%20'`).
352
+ # Related: URI.encode_uri_component (encodes <code>' '</code> as
353
+ # <code>'%20'</code>).
347
354
  #
348
355
  def self.encode_www_form_component: (_ToS str, ?encoding? enc) -> String
349
356
 
@@ -491,7 +498,8 @@ module URI
491
498
  # Returns a new object constructed from the given `scheme`, `arguments`, and
492
499
  # `default`:
493
500
  #
494
- # * The new object is an instance of `URI.scheme_list[scheme.upcase]`.
501
+ # * The new object is an instance of
502
+ # <code>URI.scheme_list[scheme.upcase]</code>.
495
503
  # * The object is initialized by calling the class initializer using `scheme`
496
504
  # and `arguments`. See URI::Generic.new.
497
505
  #
@@ -609,5 +617,5 @@ module Kernel
609
617
  #
610
618
  # You must require 'uri' to use this method.
611
619
  #
612
- def self?.URI: (URI::Generic | String uri) -> URI::Generic
620
+ def self?.URI: (URI::Generic | string uri) -> URI::Generic
613
621
  end
@@ -27,8 +27,8 @@ module URI
27
27
  # The components should be provided either as an Array, or as a Hash with keys
28
28
  # formed by preceding the component names with a colon.
29
29
  #
30
- # If an Array is used, the components must be passed in the order `[host,
31
- # path]`.
30
+ # If an Array is used, the components must be passed in the order <code>[host,
31
+ # path]</code>.
32
32
  #
33
33
  # A path from e.g. the File class should be escaped before being passed.
34
34
  #
@@ -489,8 +489,8 @@ module URI
489
489
  # rdoc-file=lib/uri/generic.rb
490
490
  # - split_userinfo(ui)
491
491
  # -->
492
- # Returns the userinfo `ui` as `[user, password]` if properly formatted as
493
- # 'user:password'.
492
+ # Returns the userinfo `ui` as <code>[user, password]</code> if properly
493
+ # formatted as 'user:password'.
494
494
  #
495
495
  def split_userinfo: (String ui) -> Array[String | nil]
496
496
 
@@ -32,8 +32,8 @@ module URI
32
32
  # The components should be provided either as an Array, or as a Hash with keys
33
33
  # formed by preceding the component names with a colon.
34
34
  #
35
- # If an Array is used, the components must be passed in the order `[userinfo,
36
- # host, port, path, query, fragment]`.
35
+ # If an Array is used, the components must be passed in the order
36
+ # <code>[userinfo, host, port, path, query, fragment]</code>.
37
37
  #
38
38
  # Example:
39
39
  #
@@ -38,8 +38,8 @@ module URI
38
38
  # The components should be provided either as an Array, or as a Hash with keys
39
39
  # formed by preceding the component names with a colon.
40
40
  #
41
- # If an Array is used, the components must be passed in the order `[host, port,
42
- # dn, attributes, scope, filter, extensions]`.
41
+ # If an Array is used, the components must be passed in the order <code>[host,
42
+ # port, dn, attributes, scope, filter, extensions]</code>.
43
43
  #
44
44
  # Example:
45
45
  #
@@ -15,13 +15,13 @@ module URI
15
15
  # Creates a new URI::MailTo object from components, with syntax checking.
16
16
  #
17
17
  # Components can be provided as an Array or Hash. If an Array is used, the
18
- # components must be supplied as `[to, headers]`.
18
+ # components must be supplied as <code>[to, headers]</code>.
19
19
  #
20
20
  # If a Hash is used, the keys are the component names preceded by colons.
21
21
  #
22
22
  # The headers can be supplied as a pre-encoded string, such as
23
- # `"subject=subscribe&cc=address"`, or as an Array of Arrays like `[['subject',
24
- # 'subscribe'], ['cc', 'address']]`.
23
+ # <code>"subject=subscribe&cc=address"</code>, or as an Array of Arrays like
24
+ # <code>[['subject', 'subscribe'], ['cc', 'address']]</code>.
25
25
  #
26
26
  # Examples:
27
27
  #
@@ -75,7 +75,7 @@ module URI
75
75
  # : String to make safe
76
76
  #
77
77
  # `unsafe`
78
- # : Regexp to apply. Defaults to `self.regexp[:UNSAFE]`
78
+ # : Regexp to apply. Defaults to <code>self.regexp[:UNSAFE]</code>
79
79
  #
80
80
  #
81
81
  # ## Description
@@ -130,8 +130,9 @@ module URI
130
130
  # rdoc-file=lib/uri/rfc2396_parser.rb
131
131
  # - make_regexp(schemes = nil)
132
132
  # -->
133
- # Returns Regexp that is default `self.regexp[:ABS_URI_REF]`, unless `schemes`
134
- # is provided. Then it is a Regexp.union with `self.pattern[:X_ABS_URI]`.
133
+ # Returns Regexp that is default <code>self.regexp[:ABS_URI_REF]</code>, unless
134
+ # `schemes` is provided. Then it is a Regexp.union with
135
+ # <code>self.pattern[:X_ABS_URI]</code>.
135
136
  #
136
137
  def make_regexp: (?Array[String] schemes) -> Regexp
137
138
 
@@ -161,7 +162,7 @@ module URI
161
162
  # rdoc-file=lib/uri/rfc2396_parser.rb
162
163
  # - split(uri)
163
164
  # -->
164
- # Returns a split URI against `regexp[:ABS_URI]`.
165
+ # Returns a split URI against <code>regexp[:ABS_URI]</code>.
165
166
  #
166
167
  def split: (String uri) -> [ String?, String?, String?, String?, String?, String?, String?, String?, String? ]
167
168
 
@@ -176,7 +177,7 @@ module URI
176
177
  # : String to remove escapes from
177
178
  #
178
179
  # `escaped`
179
- # : Regexp to apply. Defaults to `self.regexp[:ESCAPED]`
180
+ # : Regexp to apply. Defaults to <code>self.regexp[:ESCAPED]</code>
180
181
  #
181
182
  #
182
183
  # ## Description
@@ -78,9 +78,10 @@ module Zlib
78
78
  # - flush(flush = Zlib::SYNC_FLUSH) -> String
79
79
  # - flush(flush = Zlib::SYNC_FLUSH) { |chunk| ... } -> nil
80
80
  # -->
81
- # This method is equivalent to `deflate('', flush)`. This method is just
82
- # provided to improve the readability of your Ruby program. If a block is given
83
- # chunks of deflate output are yielded to the block until the buffer is flushed.
81
+ # This method is equivalent to <code>deflate('', flush)</code>. This method is
82
+ # just provided to improve the readability of your Ruby program. If a block is
83
+ # given chunks of deflate output are yielded to the block until the buffer is
84
+ # flushed.
84
85
  #
85
86
  # See Zlib::Deflate#deflate for detail on the `flush` constants NO_FLUSH,
86
87
  # SYNC_FLUSH, FULL_FLUSH and FINISH.