feat: add rustdoc documentation for all 5 contracts - #12
Open
JHON12091986 wants to merge 1 commit into
Open
Conversation
Author
|
Hi @Mona-i, this PR is ready for review. It documents all 5 contracts with full rustdoc comments, module-level documentation, and CI integration. Please let me know if any changes are needed. |
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 #9
/claim #9
📚 Full Rustdoc Documentation for All 5 Contracts
Changes
//!documentation for all 5 contracts:///doc comments for all public functionsVerification
cargo doc --no-depsruns without errors///documentation//!documentationFiles Modified
contracts/treasury/src/lib.rscontracts/loan/src/lib.rscontracts/voting/src/lib.rscontracts/governance/src/lib.rscontracts/dividend/src/lib.rsTesting
cargo checkcargo doc --no-depsReady for review | @coopfinance/maintainers
Payment wallet (USDC on Ethereum):
0x46243c949f30280771c0675Bc8A16155A9B96e51