Skip to content

fix: clean up Will struct doc comments for balances/token fields - #348

Merged
icentedward76-sketch merged 1 commit into
SoroWill:mainfrom
Hu-ter:fix/issue-335-will-struct-s-doc-comments-for-balances-token
Aug 31, 2026
Merged

icentedward76-sketch merged 1 commit into
SoroWill:mainfrom
Hu-ter:fix/issue-335-will-struct-s-doc-comments-for-balances-token

Conversation

@Hu-ter

@Hu-ter Hu-ter commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Overview

This PR fixes the Will struct's documentation in contracts/will/src/types.rs. The balances and token fields currently carry stray, duplicated doc lines left over from before the multi-token (balances: Map<Address, i128>) refactor: balances incorrectly shows "The token contract (e.g. a USDC Stellar Asset Contract) held by the will.", and token incorrectly 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.rs

    • Removes the duplicated "The token contract (e.g. a USDC Stellar Asset Contract) held by the will." doc line from the balances field.
    • Removes the stray "The beneficiaries and their percentage shares. Always sums to 100." doc line from the token field.
    • Keeps each field's doc comment focused on that field only, matching the intended post-refactor documentation.
  • [REVIEW] Rustdoc output for the Will struct

    • cargo doc --no-deps -p will confirms no other fields carry similarly misplaced comments.

Verification Results

cargo doc --no-deps -p will
✅ Will struct docs render without the stray lines

cargo test --workspace
✅ Passing

cargo clippy --all-targets -- -D warnings
✅ Passing
Acceptance Criteria Status
Remove stray/duplicated doc lines from balances and token ✅ Removed; both fields now describe only themselves
Rustdoc output reviewed for other misplaced comments ✅ No other Will fields carry leftover/mismatched text
cargo test --workspace passes ✅ Passing in CI
cargo clippy --all-targets -- -D warnings passes ✅ Passing in CI

Closes #335

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@icentedward76-sketch
icentedward76-sketch merged commit 8f3c360 into SoroWill:main Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Will struct's doc comments for balances/token fields contain leftover, mismatched text

2 participants