feat: document invoice contract public functions - #312
Open
i-amdaveee wants to merge 1 commit into
Open
Conversation
|
@i-amdaveee 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.
Summary
Closes #192
Adds
///rustdoc comments to every public entry point in both invoice contract trees:COMEBACKHERE-contracts/contracts/invoice/src/lib.rscontracts/invoice/src/lib.rsNo logic was changed — this is documentation only.
What was documented
Each public function now has:
# Parameters— every argument explained# Returns— where the return value is non-obvious# Errors— every error variant the function can return, with conditions# Events— the event emitted on success (where applicable)Cross-contract calls are explicitly noted.
raise_disputedocuments that it callstreasury.raise_dispute(claimant, settlement_id, reason)and thatset_treasurymust be called first.
set_treasurylinks back toraise_disputein its doc comment.The contract struct (
InvoiceContract) also has a top-level doc comment summarisingthe contract's responsibilities and the treasury dependency.
cargo doc output
Both invoice crates pass
cargo doc --no-depswith zero warnings from our code.The only warnings present are
unexpected cfg condition value: testutilsoriginatingfrom the soroban SDK macros themselves — these exist on
mainbefore this change.cargo test output
cargo testfails on both this branch andmainwith a pre-existingstellar-xdr/ethnumversion conflict unrelated to this change:error[E0512]: cannot transmute between types of different sizes --> ethnum-1.5.0/src/error.rs:16:14 error: could not compile ethnum (lib) due to 1 previous error error: could not compile stellar-xdr (lib) due to 1836 previous errors