Skip to content

docs(escrow): add doc comments to six view functions - #426

Merged
chonilius merged 1 commit into
MergeFi:mainfrom
Open-source-contribution-by-alfie:docs/escrow-view-fn-doc-comments
Sep 28, 2026
Merged

chonilius merged 1 commit into
MergeFi:mainfrom
Open-source-contribution-by-alfie:docs/escrow-view-fn-doc-comments

Conversation

@alfeedrips

Copy link
Copy Markdown
Contributor

Add /// doc comments to get_admin, get_oracle, get_treasury, get_fee_bps, get_version, and get_max_sponsors in contracts/escrow/src/lib.rs.

These were the only public functions in the file lacking documentation, an inconsistency with the rest of the module. Each comment describes what the function returns; get_version also notes its non-obvious default of 0 when the version flag has not been set.

Summary

Related issues

Changes

Closes #331
Closes #332
Closes #333
Closes #335

Test plan

  • Existing tests pass (make test)
  • New tests added for changed behaviour
  • Manually verified against a local node / testnet where applicable

Checklist

  • Branch is up to date with main
  • No debug / dead code left in
  • cargo fmt and cargo clippy are clean

Add /// doc comments to get_admin, get_oracle, get_treasury, get_fee_bps,
get_version, and get_max_sponsors in contracts/escrow/src/lib.rs.

These were the only public functions in the file lacking documentation,
an inconsistency with the rest of the module. Each comment describes what
the function returns; get_version also notes its non-obvious default of 0
when the version flag has not been set.
@vercel

vercel Bot commented Sep 28, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the chonilius' projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Sep 28, 2026

Copy link
Copy Markdown

@alfeedrips 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! 🚀

Learn more about application limits

@chonilius
chonilius merged commit 164ccc3 into MergeFi:main Sep 28, 2026
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment