Skip to content

docs(contracts): rustdoc comments for all public functions and modules (#9) - #33

Open
ZacLou wants to merge 1 commit into
coopfinance:mainfrom
ZacLou:docs/rustdoc-all-contracts-9
Open

docs(contracts): rustdoc comments for all public functions and modules (#9)#33
ZacLou wants to merge 1 commit into
coopfinance:mainfrom
ZacLou:docs/rustdoc-all-contracts-9

Conversation

@ZacLou

@ZacLou ZacLou commented Aug 31, 2026

Copy link
Copy Markdown

Closes #9

Adds rustdoc comments and module-level documentation across all 5 cooperative contracts:

  • treasury: module doc + complete /// docs for every pub fn.
  • loan: module doc + docs for initialize, request_loan, approve_loan, repay, get_loans, get_loan.
  • voting: module doc + docs for initialize, create_proposal, vote, finalize, get_proposals, get_votes.
  • governance: module doc + docs for initialize, update_rules, get_rules.
  • dividend: module doc + docs for initialize, distribute, get_distributions.

Also adds a docs job to .github/workflows/test.yml that runs cargo doc --no-deps --workspace.

Note: local cargo doc on this Windows environment hits a pre-existing ed25519-dalek / soroban-env-host trait-bound compile error unrelated to documentation. The documentation changes themselves are syntax-only and the new CI job should validate cargo doc --no-deps in the project's supported environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Contracts] Document all 5 contracts with rustdoc and publish cargo doc

1 participant