Enable the cfg_doc feature on docs.rs
#4064
Merged
Conversation
This file contains 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
Michael-F-Bryan
changed the title
cfg_doc feature on docs.rs/cfg_doc feature on docs.rs
theduke
approved these changes
Jul 10, 2023
…the doc_cfg feature
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.
Description
This PR makes sure docs.rs enables the
doc_cfgandauto_doc_cfgfeatures (see rust-lang/rust#43781) when generating documentation.I was checking this locally using the following command:
$ RUSTFLAGS="--cfg=docsrs" RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly d --package=wasmer-wasix --openIt doesn't 100% work for the
wasmercrate because the way we use#[cfg]to switch between backing implementations screws things up, but the other crates with simpler conditional compilation stories are documented as expected. I'm not too concerned though, because #4033 will fix things properly.Fixes #4039.