internal.h: shorten the mrb_str_valid_encoding_p comment - #7108
Merged
Conversation
The comment on the declaration restated the one on the definition: which flag the walk declines to read on the way in, why reading it would make the answer depend on whether the string had been measured before, and which flag a string that walks to one byte per character is left with. A caller reading the header needs the answer the function gives, not how it arrives at one. Keep the three answers it has to know, which are the two strings it never walks and the one it rejects, and leave the rest at the definition, where the code that does the walking is.
|
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 documentation for ChangesString encoding documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
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
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 comment on the declaration of
mrb_str_valid_encoding_p, added in #7105,restated the one on the definition in string.c: which flag the walk declines to
read on the way in, why reading it would make the answer depend on whether the
string had been measured before, and which flag a string that walks to one byte
per character is left with.
A caller reading the header needs the answer the function gives, not how it
arrives at one. Keep the three answers it has to know, which are the two strings
the walk never touches and the one it rejects, and leave the rest at the
definition, where the code that does the walking is.
Comment only; no code changes.
Verified
rake teston a full-core build: 2246 tests, all greenprek run --all-filespasses, except thatmarkdownlintcould not installlocally (npm engine mismatch); no Markdown is touched here
Summary by CodeRabbit