refactor: name the agree guard validateAgreeTolerances - #282
Closed
thedavidmeister wants to merge 1 commit into
Closed
thedavidmeister wants to merge 1 commit into
thedavidmeister wants to merge 1 commit into
Conversation
`agreeValidateTolerances` read as "agree validate tolerances". Its siblings — `agreeSpread`, `agreeAnchor`, `agreeLimit` — are noun phrases naming what they return, so the prefix carries the association and the rest of the name says what the value is. A verb belongs at the front: `validateAgreeTolerances` reads as English and still says which function's tolerances it validates. Private, so nothing outside the library refers to it. No behaviour change; 33 agree tests pass unchanged, lint and fmt clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Warning Review limit reachedNext included review available in 38 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
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 |
Contributor
Author
|
Closing: a private helper rename is not worth a PR, a release and a consumer bump. |
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.
agreeValidateTolerancesread as "agree validate tolerances".Its siblings —
agreeSpread,agreeAnchor,agreeLimit— are noun phrasesnaming what they return, so the
agreeprefix carries the association and therest of the name says what the value is. A verb does not fit that shape and
belongs at the front instead:
validateAgreeTolerancesreads as English andstill says whose tolerances it validates.
Private, so nothing outside the library refers to it.
QA
private function at its declaration and its single call site. A rename that
missed either would not compile, which is the check — and it does compile.
The 33 tests in
LibDecimalFloat.agree.t.solpass unchanged, including thefour guard tests that would fail if the call site had been dropped rather than
renamed.
an identifier. A mutant would either fail to compile or be the identical
program.
build time — an unrenamed reference is an error, and an unreferenced
declaration is an unused-function warning, which
-D warningswould fail on.Both pass.
siblings' shape". Covered: the one name. Nothing else is touched, and
agreeSpread/agreeAnchor/agreeLimitkeep their noun-phrase namesbecause those already fit.
Verification
33 agree tests pass,
forge lint -D warningsandforge fmt --checkboth exit0.
🤖 Generated with Claude Code