docs: restore set_admin rustdoc in revenue pool#386
Merged
greatest0fallt1me merged 1 commit intoMay 28, 2026
Merged
Conversation
The set_admin doc block was mis-merged: its Events section bled directly into get_usdc_token's docs, and set_admin itself had no dedicated rustdoc block. - Give set_admin its own /// block with args, panics, and both emitted events (admin_changed, admin_transfer_started) - Restore get_usdc_token's doc block in the correct position (after set_admin, before claim_admin) - No logic changes
|
@Vvictor-commits 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
3 participants
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 #343
Problem
The
set_admindoc block was mis-merged. Its# Eventssection ran directly intoget_usdc_token's docs, andset_adminitself had no dedicated///block at all.Changes
contracts/revenue_pool/src/lib.rs— doc-only, zero logic changes:set_adminits own///block documenting args, panics, and both emitted events (admin_changed,admin_transfer_started)get_usdc_token's doc block in the correct position (afterset_admin, beforeclaim_admin)Verification
cargo doc -p callora-revenue-pool --no-depsbuilds cleanlycargo clippy -p callora-revenue-pool -- -D warningspasses