docs: enforce #![deny(missing_docs)] and rustdoc::broken_intra_doc_links#98
Merged
Merged
Conversation
All 368 missing-docs errors surfaced by the 2026-05 review are now closed across the cloud crate (#90, #91, #92, #93, #94, #95, #96). This commit promotes those lints to compile errors so the bar cannot regress without a deliberate decision. - Adds #![deny(missing_docs)] to lib.rs — every public item must carry a docstring. - Adds #![deny(rustdoc::broken_intra_doc_links)] — the intra-doc links added throughout the rustdoc pass (TaskStateUpdate ↔ TaskStatus, ConnectivityHandler delegation pointers, etc.) stay valid going forward. No source-level behavior changes. cargo fmt, cargo clippy --workspace --all-targets -- -D warnings, cargo test --workspace, and cargo doc --no-deps all pass. Closes #80
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
All 368 missing-docs errors surfaced by the 2026-05 review are now closed across the cloud crate. This PR promotes the two lints to compile errors so the bar can't regress without a deliberate decision.
How we got to zero
DatabaseBackupConfigfield aliasingcargo doc --no-deps -- -D missing_docs -D rustdoc::broken_intra_doc_linksbuilds clean.Test plan
cargo fmt --all -- --checkcargo doc --no-deps(now strict by default)cargo clippy --workspace --all-targets -- -D warningscargo test --workspace— 72 doctests + the rest, all passCloses #80