Skip to content

[PeerX Backlog # 52] Add rustdoc on every public entry point #52

Description

@ameeribro4-sudo

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

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationPeerX Backlog label documentation (bulk-imported)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions