Skip to content

docs: add rustdoc coverage across workspace contracts (#52)#121

Merged
ameeribro4-sudo merged 1 commit into
OpenPeerX:mainfrom
sanusishafii989:docs/add-rustdoc-coverage
Jul 24, 2026
Merged

docs: add rustdoc coverage across workspace contracts (#52)#121
ameeribro4-sudo merged 1 commit into
OpenPeerX:mainfrom
sanusishafii989:docs/add-rustdoc-coverage

Conversation

@sanusishafii989

Copy link
Copy Markdown
Contributor

Closes #52

Summary of Changes

  • Added #![deny(missing_docs)] crate-level attribute to enforce documentation across workspace crates.
  • Added structured /// rustdoc comments to all public entry points, traits, and modules in:
    • peerx-contracts/counter/src/lib.rs
    • peerx-contracts/credit-waitlist/src/lib.rs
    • peerx-contracts/soroban-ping/src/lib.rs
    • market-data-streaming/src/lib.rs
  • Included standardized # Errors, # Events, and # Panics sections for all public methods.
image

@ameeribro4-sudo ameeribro4-sudo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LLGTM

@ameeribro4-sudo
ameeribro4-sudo merged commit 54d950c into OpenPeerX:main Jul 24, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants