Problem Statement
Public functions in lib.rs and trait methods (CallRegistry,
PoolRegistry) have inconsistent rustdoc. Many have none. cargo doc --no-deps --open shows blank pages.
Expected Outcome
Every public entry point and module has a /// block referencing:
- the unit tests it has,
- the events it emits,
- the errors it can return,
- the cross-references (called by / calls).
Acceptance Criteria
cargo doc --no-deps renders 100% pages.
- Sections per function:
# Errors, # Events, # Panics.
- A new
#![deny(missing_docs)] attribute is added at the top of
lib.rs (it is not present today — verify with
grep -n 'deny(missing_docs)' peerx-contracts/counter/src/lib.rs).
cargo doc --no-deps produces zero warnings after the attribute is set.
Files Affected
- All
peerx-contracts/*/src/*.rs.
Dependencies Issue #21.
Difficulty / Effort 🥈 / XL
Labels documentation
Problem Statement
Public functions in
lib.rsand trait methods (CallRegistry,PoolRegistry) have inconsistent rustdoc. Many have none.
cargo doc --no-deps --openshows blank pages.Expected Outcome
Every public entry point and module has a
///block referencing:Acceptance Criteria
cargo doc --no-depsrenders 100% pages.# Errors,# Events,# Panics.#![deny(missing_docs)]attribute is added at the top oflib.rs(it is not present today — verify withgrep -n 'deny(missing_docs)' peerx-contracts/counter/src/lib.rs).cargo doc --no-depsproduces zero warnings after the attribute is set.Files Affected
peerx-contracts/*/src/*.rs.Dependencies Issue #21.
Difficulty / Effort 🥈 / XL
Labels
documentation