Enable all-features when docs.rs builds the crate. #15
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
Without all-features, none of the formats end up being documented. Additionally: - Use the cfg option doc rather than feature docs, which I don't believe exists. - Disable `doc(cfg(...))` on the `formats` module, because rustdoc appears to have a bug that causes all the items within the module to inherit this doc attribute rather than using the doc attributes on their immediate definitions. Tested with `RUSTDOCFLAGS="--cfg docsrs" cargo doc --all-features --open`
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.
Without all-features, none of the formats end up being documented.
Additionally:
doc(cfg(...))on theformatsmodule, because rustdoc appearsto have a bug that causes all the items within the module to inherit
this doc attribute rather than using the doc attributes on their
immediate definitions.