docs: enable missing_docs + document public APIs in 4 crates - #3469
Closed
jewoos2921 wants to merge 1 commit into
Closed
docs: enable missing_docs + document public APIs in 4 crates#3469jewoos2921 wants to merge 1 commit into
jewoos2921 wants to merge 1 commit into
Conversation
Add #![warn(missing_docs)] and crate-level //! docs to buzz-cli, buzz-acp, buzz-dev-mcp, and buzz-ws-client, clearing all missing_docs warnings. Core crates (buzz-core, buzz-auth, buzz-db, etc.) already enforce missing_docs; this extends the same standard to the auxiliary crates that were missing it, improving rustdoc output and API discoverability. Changes per crate: - buzz-ws-client: crate doc + 3 module docs - buzz-acp: crate doc + run() function doc - buzz-dev-mcp: crate doc + run() function doc - buzz-cli: crate doc + ~70 items (enums, variants, struct fields, functions across lib.rs, agent_management.rs, main.rs) All changes are doc-comment-only (132 insertions, 0 deletions).
This was referenced Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Core crates (
buzz-core,buzz-auth,buzz-db, etc.) already enforce#![warn(missing_docs)]. This PR extends the same standard to 4 auxiliary crates that were missing it, clearing allmissing_docswarnings and improving rustdoc output.Changes
buzz-ws-client//!doc + 3 module docs (connection,error,message)buzz-acp//!doc +run()function docbuzz-dev-mcp//!doc +run()function docbuzz-cli//!doc + enums, variants, struct fields, and functions acrosslib.rs,agent_management.rs,main.rs132 insertions, 0 deletions — all changes are doc-comment-only. No code logic was modified.
Verification
RUSTDOCFLAGS="-W missing_docs" cargo doc— zero missing_docs warnings across all 4 cratescargo clippy -- -D warnings— cleancargo fmt --check— clean