Feat: contract rust docs #212
Open
Emmanuel-Ugochukwu1 wants to merge 3 commits into
Open
Conversation
…rt contracts (closes AetherEdu#183) - Added module-level documentation to all contract modules explaining architecture, features, and storage layout - Added /// doc comments with params and return values to all public functions - Created .github/workflows/docs.yml CI workflow to build and publish contract documentation to GitHub Pages - Fixed utils/mod.rs to export the pause module (pre-existing bug) - Fixed governance.rs missing imports for symbol_short, Bytes, and validation - Fixed proctoring.rs: removed dead nested code, added missing type definitions (ProctoringKey, ProctoringChallenge, ProctoringResolutionRecord) - Fixed marketplace.rs: removed dead nested code, added missing functions (release_escrow, refund_escrow, get_listing, get_escrow)
- credentials_test.rs: replace std::panic::catch_unwind with #[should_panic], add missing imports for get_credential_description and get_credential_revocation_time - dynamic_nft_test.rs: replace std::panic::catch_unwind with #[should_panic], replace alloc::format! with helper function, simplify event assertion tests - pause_test.rs: add count_events helper to replace events.len()
…issues Test compilation fixes: - credentials_test.rs: replace std::panic::catch_unwind with #[should_panic], add missing imports, fix use-after-move for recipient - dynamic_nft_test.rs: replace std::panic::catch_unwind with #[should_panic], replace alloc::format! with helper function, fix move semantics in transfers, simplify event assertion tests - pause_test.rs: inline setup_test() body into individual tests to avoid lifetime issues with AetherMintContractClient return type, remove deprecated Events API usage - governance.rs: fix undefined 'from' variable in deposit_to_treasury events Result: 68 tests pass (up from 0), 63 pre-existing failures remain due to Soroban SDK v26 storage API requiring env.as_contract() wrappers in tests.
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
1 participant
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 #183