Make feature-gated items visible in docs.rs documentation - #160
Open
mikwielgus wants to merge 1 commit into
Open
Make feature-gated items visible in docs.rs documentation#160mikwielgus wants to merge 1 commit into
mikwielgus wants to merge 1 commit into
Conversation
Currently, the implementations of `Serialize` and `Deserialize` are invisible on Docs.rs, because they are gated by `serde` feature, Docs.rs needs a feature to be enabled to display documentation of items gated by it. So, let's enable all features for Docs.rs. To enable `feature(doc_cfg)`, which is required for docs to display behind which features each item is, let's also pass `--cfg doc`.
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.
Currently, the implementations of
SerializeandDeserializeare invisible on Docs.rs, because they are gated byserdefeature, and Docs.rs needs a given feature to be enabled to display items behind it in documentation.So, let's enable all features for Docs.rs.
To enable
feature(doc_cfg), which is required for docs to display behind which features each item is, let's also pass--cfg doc.