Problem
src/contracts/logic.rs (700 lines) and src/contracts/proxy_entry.rs (917 lines) — the two largest files in the crate, and the core of the contract's public surface and upgrade-proxy logic — have zero /// rustdoc comments between them.
Why it matters
plan.md's "Documentation" section explicitly asks for "Inline rustdoc — add /// doc comments to every public function explaining parameters, errors, and side-effects." These two files are the highest-value, highest-complexity target for that and currently have none, making them the hardest files in the repo for a new contributor to safely modify.
Acceptance criteria
Scope
Doc comments only in the two named files. Do not modify function bodies or signatures.
Definition of done
Every public function in logic.rs and proxy_entry.rs has a rustdoc comment describing its parameters, errors, and side effects; cargo doc --no-deps builds without missing-docs warnings for these two files.
Problem
src/contracts/logic.rs(700 lines) andsrc/contracts/proxy_entry.rs(917 lines) — the two largest files in the crate, and the core of the contract's public surface and upgrade-proxy logic — have zero///rustdoc comments between them.Why it matters
plan.md's "Documentation" section explicitly asks for "Inline rustdoc — add///doc comments to every public function explaining parameters, errors, and side-effects." These two files are the highest-value, highest-complexity target for that and currently have none, making them the hardest files in the repo for a new contributor to safely modify.Acceptance criteria
///doc comments to everypub fninsrc/contracts/logic.rs, covering parameters, return value, error conditions, and any side effects (storage writes, events emitted, auth requirements)pub fninsrc/contracts/proxy_entry.rscargo docbuilds cleanly with no warnings about missing docs (if#[warn(missing_docs)]is enabled; otherwise just verify visually)Scope
Doc comments only in the two named files. Do not modify function bodies or signatures.
Definition of done
Every public function in
logic.rsandproxy_entry.rshas a rustdoc comment describing its parameters, errors, and side effects;cargo doc --no-depsbuilds without missing-docs warnings for these two files.