Skip to content

Commit cb8f186

Browse files
naitohhsbt
authored andcommitted
[ruby/strscan] [DOC] doc/strscan/strscan.md - update Matcher Methods
(ruby/strscan#123) Added support for string pattern type in ruby/strscan#106. And fix Success Return content. ruby/strscan@6a5acde674
1 parent b5ed7aa commit cb8f186

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/strscan/strscan.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -327,13 +327,13 @@ and attempts to find a matching substring in the [target substring][3].
327327
| Method | Pattern Type | Matches Target Substring | Success Return | May Update Positions? |
328328
|--------------|-------------------|--------------------------|--------------------|-----------------------|
329329
| #check | Regexp or String. | At beginning. | Matched substring. | No. |
330-
| #check_until | Regexp. | Anywhere. | Substring. | No. |
331-
| #match? | Regexp or String. | At beginning. | Updated position. | No. |
332-
| #exist? | Regexp. | Anywhere. | Updated position. | No. |
330+
| #check_until | Regexp or String. | Anywhere. | Substring. | No. |
331+
| #match? | Regexp or String. | At beginning. | Match size. | No. |
332+
| #exist? | Regexp or String. | Anywhere. | Substring size. | No. |
333333
| #scan | Regexp or String. | At beginning. | Matched substring. | Yes. |
334-
| #scan_until | Regexp. | Anywhere. | Substring. | Yes. |
334+
| #scan_until | Regexp or String. | Anywhere. | Substring. | Yes. |
335335
| #skip | Regexp or String. | At beginning. | Match size. | Yes. |
336-
| #skip_until | Regexp. | Anywhere. | Position delta. | Yes. |
336+
| #skip_until | Regexp or String. | Anywhere. | Substring size. | Yes. |
337337

338338
<br>
339339

@@ -351,14 +351,14 @@ Which matcher you choose will depend on:
351351
- Traverse, by advancing the positions:
352352
#scan, #scan_until, #skip, #skip_until.
353353
- Keep the positions unchanged:
354-
#check, #check_until, #exist?, #match?.
354+
#check, #check_until, #match?, #exist?.
355355

356356
- What you want for the return value:
357357

358-
- The matched substring: #check, #check_until, #scan, #scan_until.
359-
- The updated position: #exist?, #match?.
360-
- The position delta: #skip_until.
361-
- The match size: #skip.
358+
- The matched substring: #check, #scan.
359+
- The substring: #check_until, #scan_until.
360+
- The match size: #match?, #skip.
361+
- The substring size: #exist?, #skip_until.
362362

363363
### Match Values
364364

0 commit comments

Comments
 (0)