Fix call-seq return values#207
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the RDoc call-seq documentation in ext/strscan/strscan.c so the documented return values match the actual behavior of StringScanner methods (no runtime behavior changes).
Changes:
- Correct
match?to document returningmatch_size(length) rather than an updated position. - Fix
skipcall-seqformatting to include the->return arrow. - Clarify
scan_fullmay return either a matched substring or a length (ornil). - Clarify
scan_bytecan returnnilat end-of-string.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
Good catch! |
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
May 21, 2026
(ruby/strscan#207) Some `call-seq` comments did not match the actual return values (documentation only, no behavior change): * `match?` returns the match size, not a position * `skip` was missing the `->` arrow * `scan_full` can also return a length * `scan_byte` can return `nil` at end of string ruby/strscan@db4cc96c2e
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some
call-seqcomments did not match the actual return values (documentation only, no behavior change):match?returns the match size, not a positionskipwas missing the->arrowscan_fullcan also return a lengthscan_bytecan returnnilat end of string