Skip to content

docs: add missing_docs lint and close all rustdoc coverage gaps#73

Merged
ContextVM-org merged 1 commit into
ContextVM:mainfrom
harsh04044:docs/rustdoc-coverage-and-missing-docs-lint
May 9, 2026
Merged

docs: add missing_docs lint and close all rustdoc coverage gaps#73
ContextVM-org merged 1 commit into
ContextVM:mainfrom
harsh04044:docs/rustdoc-coverage-and-missing-docs-lint

Conversation

@harsh04044
Copy link
Copy Markdown

@harsh04044 harsh04044 commented May 8, 2026

Follow-up to PR #67.

Added #![warn(missing_docs)] to lib.rs as a permanent regression guard - any new public item without a doc comment will now trigger a compiler warning.

Closed the remaining gaps:

  • doc comments on all 9 pub mod declarations in lib.rs
  • /// on both encryption helper functions (were // comments)
  • /// on GiftWrapMode enum (was // comment)
  • /// on missing correlation store methods (new, contains, clear)
  • /// on all 4 SessionSnapshot fields
  • visual section separators on re-export groups in lib.rs

RUSTFLAGS='-W missing_docs' cargo check --all-features - 0 warnings.

@ContextVM-org ContextVM-org merged commit 1613472 into ContextVM:main May 9, 2026
2 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.

2 participants