docs: enable missing_docs across remaining 8 workspace crates - #3501
Closed
jewoos2921 wants to merge 1 commit into
Closed
docs: enable missing_docs across remaining 8 workspace crates#3501jewoos2921 wants to merge 1 commit into
jewoos2921 wants to merge 1 commit into
Conversation
Complete the workspace-wide missing_docs effort. With #3469 (buzz-cli, buzz-acp, buzz-dev-mcp, buzz-ws-client) and #3500 (buzz-persona), this PR covers the final 8 crates. Every workspace crate now enforces #![warn(missing_docs)]. ## Crates documented (~600 items total) - buzz-pair-relay (3 items): Relay struct + constructor - buzz-media (55 items): MediaError variants, bucket_index/storage fields - buzz-agent (127 items): types.rs enums/structs, auth.rs/config.rs APIs - buzz-relay-mesh (192 items): mesh traits, peer/endpoint/gossip/wire APIs - buzz-push-gateway (223 items): apns/app_attest/authority/grant/model APIs - buzz-conformance (0 items): attribute only — already fully documented - git-credential-nostr (0 items): attribute only - git-sign-nostr (0 items): attribute only Also fixed several pre-existing broken intra-doc links that surfaced during the doc build (buzz-media, buzz-agent). All changes are doc-comment-only (684 insertions, 27 deletions — the deletions are mechanical doc-link/format fixes).
Author
|
Closing — removing this PR. |
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
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
Completes the workspace-wide
missing_docseffort. Combined with #3469 and #3500, every workspace crate now enforces#![warn(missing_docs)].Crates documented (~600 items, 684 insertions)
buzz-pair-relayRelaystruct + constructorbuzz-mediaMediaErrorvariants,bucket_index/storagefieldsbuzz-agenttypes.rsenums/structs/methods,auth.rs/config.rsAPIsbuzz-relay-meshpeer/endpoint/gossip/wire/statusAPIsbuzz-push-gatewayapns/app_attest/authority/grant/model/tokenAPIsbuzz-conformancegit-credential-nostrgit-sign-nostrAlso fixed several pre-existing broken intra-doc links surfaced during the doc build.
Verification
RUSTDOCFLAGS="-W missing_docs" cargo doc— 0 missing warnings across all 8 cratescargo clippy -- -D warnings— cleancargo fmt --check— cleanWorkspace-wide result
After #3469 + #3500 + this PR, all 23 workspace crates enforce
missing_docs:(* = added in #3469 or #3500)