Mark feature-gated items in docs #55
Open
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
We’re making use of the [`doc(cfg(..))`][1] attribute to mark items in the docs that are behind feature flags. The approach seems pretty standard and is, for example, followed by the `futures-*` and `async_std` crates. To ensure this is tested we add an additional travis job for this. This also checks the [`broken_intra_doc_links`][2] lint. To pass, we fixed the links in the crate documentation in `lib.rs`. [1]: https://doc.rust-lang.org/rustdoc/unstable-features.html#documenting-platform-feature-specific-information [2]: https://doc.rust-lang.org/rustdoc/lints.html#broken_intra_doc_links
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.
We’re making use of the
doc(cfg(..))attribute to mark items in the docs that are behind feature flags. The approach seems pretty standard and is, for example, followed by thefutures-*andasync_stdcrates.To ensure this is tested we add an additional travis job for this. This also checks the
broken_intra_doc_linkslint. To pass, we fixed the links in the crate documentation inlib.rs.