fix: clean up Will struct doc comments for balances/token fields - #348
Merged
icentedward76-sketch merged 1 commit intoAug 31, 2026
Conversation
|
@Hu-ter Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Overview
This PR fixes the
Willstruct's documentation incontracts/will/src/types.rs. Thebalancesandtokenfields currently carry stray, duplicated doc lines left over from before the multi-token (balances: Map<Address, i128>) refactor:balancesincorrectly shows "The token contract (e.g. a USDC Stellar Asset Contract) held by the will.", andtokenincorrectly shows "The beneficiaries and their percentage shares. Always sums to 100." These leftovers are removed so each field's doc comment describes only that field.Related Issue
Closes #
Changes
📝 Will Struct Doc Cleanup
[MODIFY]
contracts/will/src/types.rsbalancesfield.tokenfield.[REVIEW] Rustdoc output for the
Willstructcargo doc --no-deps -p willconfirms no other fields carry similarly misplaced comments.Verification Results
balancesandtokenWillfields carry leftover/mismatched textcargo test --workspacepassescargo clippy --all-targets -- -D warningspassesCloses #335