mruby-regexp: list String#sub! and #gsub! in the README - #7076
Merged
Conversation
The `Ruby API` section of the gem's README lists the String methods that take a Regexp here, and the bang pair added in b4f41f8 never reached that list, so the README still reads as though only `sub` and `gsub` accept a pattern. ```ruby s = "hello world" s.sub!(/o/, "0") # => "hell0 world", documented nowhere ``` Add the four spellings next to the non-bang pair they mirror, and state the return value the bang form differs on: self when a substitution took place and nil when the pattern did not match.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe mruby-regexp README now documents ChangesRegexp documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
2 participants
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.
The
Ruby APIsection ofmrbgems/mruby-regexp/README.mdlists the Stringmethods that take a Regexp in this gem. The bang pair added in b4f41f8
(#7061) never reached that list, so the README still reads as though only
subandgsubaccept a pattern.Documentation only, no behavior change. The four spellings go next to the
non-bang pair they mirror, and the comment states the one thing the bang form
differs on: self when a substitution took place and nil when the pattern did
not match, which is what
sub!answers there today.Summary by CodeRabbit
Stringreplacement methodssub!andgsub!.