build: validate rustdoc across feature selections - #261
Closed
tisonkun wants to merge 2 commits into
Closed
Conversation
Asyncband exposes no APIs by default, but the crate overview and the rwlock guide linked directly to modules that may be disabled. Documentation builds with warnings denied therefore failed for legitimate dependency configurations. Use docs.rs targets so the feature catalog remains navigable without requiring unrelated features. Signed-off-by: tison <wander4096@gmail.com>
The all-features documentation build hides links that accidentally cross feature boundaries. Exercise the no-feature and every single-feature configurations so cargo x lint catches documentation that downstream users cannot build. Signed-off-by: tison <wander4096@gmail.com>
Member
Author
|
No. We only care about docs build on docs.rs. |
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
rwlockguide's link to the independently gatedmutexAPI.Design Notes
Asyncband has no default features, so no-feature and single-feature dependency configurations are part of the supported surface. Before this change,
cargo doc -p asyncband --no-default-featuresfailed on the crate's API map, while therwlock-only configuration failed on its cross-featureMutexlink. The existing all-features documentation check hid both failures.This intentionally limits the 0.7.0 audit follow-up to reproducible failures. It does not include speculative API redesigns, mechanical trait additions, test deletion, or performance changes without evidence.
Validation
cargo x lintcargo x checkcargo x testcargo x miriRUSTUP_TOOLCHAIN=1.86.0 cargo x test --no-capturecargo x semver --release-version 0.7.0 --acknowledge-breaking-changescargo package --package asyncband