docs(contracts): document loan manager lifecycle methods#1257
Open
gitcommit90 wants to merge 1 commit into
Open
docs(contracts): document loan manager lifecycle methods#1257gitcommit90 wants to merge 1 commit into
gitcommit90 wants to merge 1 commit into
Conversation
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 #1133
Add focused
///rustdoc blocks to the six publicloan_managerlifecycle functions that currently have no documentation:request_loan,approve_loan,repay,deposit_collateral,liquidate, andcancel_loan.Each doc block covers:
LoanStatusvariants required)LoanErrorvariants with the condition that triggers eachNo runtime behavior changes — rustdoc comments only.
Verification:
rustfmt --check --config skip_children=true loan_manager/src/lib.rs— exit 0cargo check -p loan_manager --lib— passesRUSTDOCFLAGS=-Dwarnings cargo doc -p loan_manager --no-deps— passes, no warningscargo clippy -p loan_manager --lib -- -D warnings— passescargo test -p loan_manager— pre-existing compile error in untouchedtest.rs(unrelatedsoroban_sdk::ValPartialEqissue); this branch touches onlylib.rsgit diff main...HEAD --name-only—contracts/loan_manager/src/lib.rsonly