Show members for all features in docs#87
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
2 participants
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.
The docs.rs documentation is currently not very useful, as it doesn't show anything that is conditionally compiled by enabling non-default features. With this PR all members are always shown, with an optional note next to them indicating if they are feature-gated.
Test this change by generating the docs locally with the following cargo command
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-featuresSome of the dependencies' documentation is borked because of rust-lang/rust#43781 which interferes with local documentation builds. I don't know docs.rs handles this; it's possible these dependencies will have to be bumped.