docs(models): document fields in the four large request/response modules#96
Merged
Merged
Conversation
Add field-level rustdoc to the four largest model modules so the crate compiles cleanly under `RUSTDOCFLAGS="-D missing_docs"`: - `src/fixed/databases.rs` - `src/fixed/subscriptions.rs` - `src/flexible/databases.rs` - `src/flexible/subscriptions.rs` Closes the missing-docs gap for these files (249 -> 0) using the conventions established in #92 and #94 — short, factual one-liners, `subscription_id`/`database_id` on request bodies noted as "Server-populated from the path", `command_type` documented as a read-only server-set discriminator, and nested structs linked via intra-doc references. Pure docs change: no struct fields, types, or wire shapes were modified. Refs #80.
This was referenced May 19, 2026
joshrotenberg
added a commit
that referenced
this pull request
May 19, 2026
…nks (#98) 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
Field-level rustdoc pass on the four largest model modules so the crate compiles cleanly under
RUSTDOCFLAGS="-D missing_docs":src/fixed/databases.rs(~70 fields)src/fixed/subscriptions.rs(~65 fields)src/flexible/databases.rs(~62 fields)src/flexible/subscriptions.rs(~52 fields)Approximately 249 missing-docs errors across these four files reduced to 0. Uses the conventions established in #92 (types) and #94 (small modules):
# Errors/# Examplessections on fields)subscription_id/database_idon request bodies documented as "Server-populated from the path"command_typedocumented as the read-only server-set operation discriminatorSee [ReplicaOfSpec].)links: Option<Vec<Link>>left as the existingHATEOAS linksconventionThis PR is docs-only: no struct fields, types, serde renames, or wire shapes were modified.
Refs #80.
Test plan
cargo fmt --all -- --checkpassescargo clippy --workspace --all-targets -- -D warningscleancargo test --workspacepasses (all tests green, including wiremock-based integration tests)RUSTDOCFLAGS="-D missing_docs" cargo doc --no-deps --workspacereports 0 errors in the four target files (remaining 22 errors live inusers.rs, covered by docs(users): document all undocumented fields in user request/response models #95)