docs: enable missing_docs + document all public APIs in buzz-persona - #3500
Closed
jewoos2921 wants to merge 1 commit into
Closed
docs: enable missing_docs + document all public APIs in buzz-persona#3500jewoos2921 wants to merge 1 commit into
jewoos2921 wants to merge 1 commit into
Conversation
Add #![warn(missing_docs)] and crate-level //! docs to buzz-persona, clearing all ~130 missing_docs warnings. This is the last crate in the workspace to receive the missing_docs treatment, completing the effort started in #3469. Documents ~130 public items across 7 files: - lib.rs: crate doc + 6 module docs - manifest.rs: ManifestError enum + variants, BehavioralDefaults/PackManifest fields - merge.rs: TriggersData, HooksData, ResolvedConfig structs + fields (also fixed a module-level doc comment misattached as outer doc) - pack.rs: PackError enum + 8 variants, LoadedPack/LoadedPersona/PackManifestData fields - persona.rs: PersonaError enum + variants, McpServerConfig/Hooks fields - resolve.rs: ResolvedPersona (~17 fields), ResolvedMcpServer/Hooks/Triggers/Pack - validate.rs: ValidationDiagnostic enum + variants, ValidationReport methods All changes are doc-comment-only (170 insertions, 11 deletions — the deletions are mechanical /// → //! conversions required by clippy).
3 tasks
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
Completes the workspace-wide
missing_docseffort by enabling it inbuzz-persona— the last crate that lacked it.This follows #3469, which added
missing_docstobuzz-cli,buzz-acp,buzz-dev-mcp, andbuzz-ws-client. With this PR, every workspace crate now enforces#![warn(missing_docs)].Changes
~130 public items documented across 7 files (170 insertions, 11 deletions):
lib.rs//!doc + 6 module docs +#![warn(missing_docs)]manifest.rsManifestErrorenum + 3 variants,BehavioralDefaults/PackManifestfieldsmerge.rsTriggersData,HooksData,ResolvedConfigstructs + all fieldspack.rsPackErrorenum + 8 variants (incl. struct-variant fields),LoadedPack/LoadedPersona/PackManifestDatafieldspersona.rsPersonaErrorenum + 7 variants,McpServerConfig/Hooksfieldsresolve.rsResolvedPersona(~17 fields),ResolvedMcpServer/Hooks/Triggers/Packvalidate.rsValidationDiagnosticenum + variants,ValidationReportmethodsThe 11 deletions are mechanical
///→//!conversions required by clippy'sempty_line_after_doc_commentslint (a module-level doc block was misattached as an outer doc comment on the first struct).Verification
RUSTDOCFLAGS="-W missing_docs" cargo doc -p buzz-persona— zero missing_docs warningscargo clippy -p buzz-persona -- -D warnings— cleancargo fmt --check -p buzz-persona— cleancargo test -p buzz-persona— 13 passed, 0 failed