docs: restore doc_cfg feature gate - #1228
Merged
Merged
Conversation
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
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.
Problem
The documentation build for wreq v6.0.0-rc.29 fails on docs.rs with E0658 because #[doc(cfg)] is experimental:
The package metadata passes --cfg docsrs to rustdoc. That activates the existing #[cfg_attr(docsrs, doc(cfg(...)))] annotations, but the crate-level doc_cfg feature gate is no longer present, so nightly rustdoc rejects those annotations.
Background
The conditional doc_cfg feature gate was removed in commit 29da5662, whose message describes doc_cfg as deprecated.
However, doc_cfg itself has not been deprecated or stabilized upstream:
Therefore, crates using explicit #[doc(cfg(...))] annotations still need to enable doc_cfg when docs.rs builds them with nightly Rust.
Fix
Restore the conditional crate attribute #![cfg_attr(docsrs, feature(doc_cfg))]. It is enabled only when cfg(docsrs) is set, so normal stable builds remain unaffected while docs.rs can build the feature availability annotations.
Verification
Both checks completed successfully locally: