Migrate to doc_auto_cfg
#1370
Merged
Migrate to doc_auto_cfg
#1370
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
Migrates the `aead`, `cipher`, `crypto-common`, `digest`, and `universal-hash` crates to use the `doc_auto_cfg` feature which automatically generates documentation for `cfg`-gated code, which in our uses is almost exclusively gated on crate features. This allows the previous manual `doc_cfg` annotations to be removed, which is nice as they otherwise duplicate work whenever `cfg`-gated code is used.
newpavlov
approved these changes
Oct 31, 2023
tarcieri
added a commit
that referenced
this pull request
Jan 8, 2024
These were leftover from the migration to `doc_auto_cfg` in #1370. They're breaking the doc build.
tarcieri
added a commit
that referenced
this pull request
Jan 8, 2024
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.
Migrates the
aead,cipher,crypto-common,digest, anduniversal-hashcrates to use thedoc_auto_cfgfeature which automatically generates documentation forcfg-gated code, which in our uses is almost exclusively gated on crate features.This allows the previous manual
doc_cfgannotations to be removed, which is nice as they otherwise duplicate work whenevercfg-gated code is used.