Skip to content

Add #![warn(missing_docs)] to all four crates and fix newly-surfaced … - #424

Merged
chonilius merged 1 commit into
MergeFi:mainfrom
Data-Block1010:docs/enforce-missing-docs
Sep 28, 2026
Merged

chonilius merged 1 commit into
MergeFi:mainfrom
Data-Block1010:docs/enforce-missing-docs

Conversation

@wandooadzer-cmyk

Copy link
Copy Markdown

…warnings

  • Add #![warn(missing_docs)] to mergefi-common, mergefi-escrow, mergefi-milestones, and mergefi-maintenance-pool
  • Add doc comments to all previously undocumented public items in common (traits, functions, constants) and split.rs (struct fields)
  • Add doc comments to getter/setter functions in maintenance-pool and milestones
  • Wrap contract definitions in #[allow(missing_docs)] modules to suppress warnings from macro-generated code (contract, contractimpl)
  • Fix pre-existing syntax error in escrow (missing closing brace)
  • Update README with documentation enforcement section

Summary

Related issues

Changes

Closes #324
Closes #334
Closes #337
Closes #336

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

…warnings

- Add #![warn(missing_docs)] to mergefi-common, mergefi-escrow,
  mergefi-milestones, and mergefi-maintenance-pool
- Add doc comments to all previously undocumented public items in
  common (traits, functions, constants) and split.rs (struct fields)
- Add doc comments to getter/setter functions in maintenance-pool
  and milestones
- Wrap contract definitions in #[allow(missing_docs)] modules to
  suppress warnings from macro-generated code (contract, contractimpl)
- Fix pre-existing syntax error in escrow (missing closing brace)
- Update README with documentation enforcement section
@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

@wandooadzer-cmyk 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 711ece9 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