Remove #[doc(cfg(...))] attributes
#1554
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
arqunis
added
enhancement
|
What a bliss not to have to duplicate all of the cfg's anymore 😌 |
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 removes all uses of the
#[doc(cfg(...))]attribute. The purpose of this attribute was to tellrustdocto add an annotation, which would inform users what features an item (module, struct, trait, method, etc.) needed. However, in the latest Nightly, this attribute is implicit when#![feature(doc_cfg)]is enabled. Thus, our usage of this attribute is unnecessary and we can remove it.Type of Change
This is an enhancement to the library's code by removing clutter, which is related to documentation.
How Has This Been Tested?
This has been tested by ensuring existing annotations haven't been removed.