fix: document panic behavior in operator overloads (issue #180 fix 2)#182
Merged
Conversation
Agent-Logs-Url: https://github.com/mfirhas/moneylib/sessions/7cba31c6-d95f-44c9-ac06-18cb27bc3cc0 Co-authored-by: mfirhas <11944811+mfirhas@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
mfirhas
May 19, 2026 22:32
View session
mfirhas
approved these changes
May 19, 2026
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Closes #180 (Fix No. 2).
Every arithmetic operator overload (
+,-,+=,-=,*,/,%) forMoneyandRawMoneypreviously panicked on overflow with only an internal// WARN: PANIC!source comment as warning — nothing visible in the public docs.This PR adds a
# Panicsdoc section to each operator impl, documenting the overflow condition and directing users to the correspondingBaseOps::checked_*method for safe arithmetic:Add/AddAssign→BaseOps::checked_addSub/SubAssign→BaseOps::checked_subMul→BaseOps::checked_mulDiv→BaseOps::checked_div(also notes divide-by-zero)Rem→BaseOps::checked_rem(also notes divide-by-zero)The internal
// WARN: PANIC!comments are removed as the public doc now carries this information. No logic is changed.