[DOC] Tweaks for String#byterindex #13485
Open
Conversation
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
peterzhu2118
reviewed
Jun 3, 2025
| /* | ||
| * call-seq: | ||
| * byterindex(substring, offset = self.bytesize) -> integer or nil | ||
| * byterindex(regexp, offset = self.bytesize) -> integer or nil | ||
| * byterindex(object, offset = 0) -> integer or nil |
There was a problem hiding this comment.
I don't think the new default of offset of 0 is correct.
irb(main):003> "hello".byterindex("l")
=> 3
irb(main):004> "hello".byterindex("l", 0)
=> nil
irb(main):005> "hello".byterindex("l", 10)
=> 3| * | ||
| * Returns the Integer byte-based index of the _last_ occurrence of the given +substring+, | ||
| * or +nil+ if none found: | ||
| * Returns the 0-based integer index of a substring of +self+ |
There was a problem hiding this comment.
I think it's important to mention that it finds the last match in the first sentence.
| * 'foo'.byterindex('o', 2) # => 2 | ||
| * 'foo'.byterindex('o', 3) # => 2 | ||
| * \Integer argument +offset+, if given, specifies the 0-based index | ||
| * of the byte where searching is to begin. |
There was a problem hiding this comment.
That's not correct, offset is the index to end the search.
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.
No description provided.