docs(connectivity): expand thin module headers (psc, transit_gateway, vpc_peering)#93
Merged
Merged
Conversation
… vpc_peering) The headers on psc.rs, transit_gateway.rs, and vpc_peering.rs were three lines each despite each module hosting 9-19 public methods. Now each header carries: - A one-paragraph summary of what the module is for - A 'When to use this module' section that distinguishes it from the three sibling connectivity modules (vpc_peering vs psc vs transit_gateway vs private_link) - The full REST endpoint surface (standard + Active-Active) - A blanket 'Errors' note pointing at CloudError - A runnable example on vpc_peering using the for_aws constructor private_link.rs already has a multi-paragraph Overview section and is left as-is. 71 doctests pass (was 70 — the new vpc_peering example). Refs #80 (rustdoc umbrella — P2 thin-module-headers slice)
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
psc.rs,transit_gateway.rs, andvpc_peering.rshad three-line module headers despite each hosting 9–19 public methods. This PR brings them up to the same depth asprivate_link.rs(which already has a multi-paragraph Overview).What each module header now carries
# Errorsnote pointing atCloudErrorvpc_peeringusing thefor_awsconstructor from fix(connectivity): vpc_peering create sends wrong JSON keys (awsRegion vs region) #75private_link.rsis left untouched — its header was already fine.Test plan
cargo fmt --all -- --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspace— all pass; 71 doctests (was 70: the newvpc_peeringexample)Refs #80