Fix error naming conventions - #627
Open
d3v-active wants to merge 3 commits into
Open
Conversation
|
@d3v-active 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.
Closes #502
This PR reviews and standardizes the error naming conventions and documentation across all smart contracts in the repository to ensure they follow NatSpec (Rust documentation) standards.
Changes Made
While the error enums were already correctly named using standard Rust/Soroban conventions (e.g.,
SplitError,TokenError, etc.), many of the variants lacked descriptive documentation, making it harder for developers and users to understand why an operation failed.The following contracts were updated to include clear and accurate docstrings for all custom error variants:
split/src/lib.rs: Added complete documentation forSplitError.token/src/lib.rs: Added complete documentation forTokenError.vesting/src/lib.rs: Added complete documentation forVestingError.wrapper/src/lib.rs: Added complete documentation for all previously undocumented variants ofWrapperError.Acceptance Criteria Met
cargo fmtandcargo clippywere run to verify).Impact
No business logic was changed. These are purely documentation enhancements to improve the developer experience and maintain code quality and consistency across the project.