Fix doctests that require feature-gated modules #51
+31
−1
Conversation
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
The doctests for CryptoProvider examples reference `aws_lc_rs` and `certificate` modules which are gated behind `aws-lc-rs` and `rcgen` features respectively. When running tests with only `rust-crypto` feature enabled, these doctests fail to compile. Mark these examples with `ignore` and add comments documenting the required features. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The module-level doctest uses the `certificate` module which requires the `rcgen` feature. Mark it with `ignore` and document the requirement. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Use hidden `# if cfg!(feature = "...")` blocks to conditionally compile doctests based on required features, rather than ignoring them entirely. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Use hidden `# if cfg!(feature = "...")` block to conditionally compile the doctest based on required features. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The cfg!() macro is evaluated at runtime, not compile time, so it doesn't prevent the code from being compiled. Use #[cfg(...)] attributes on wrapper functions instead to conditionally compile doctests. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The cfg!() macro is evaluated at runtime, not compile time. Use #[cfg] attribute on wrapper functions to conditionally compile the doctest. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The doctests use the `certificate` module which requires the `rcgen` feature. Add #[cfg] wrapper functions to conditionally compile them. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
Fixes doctest failures when running tests with only the
rust-cryptofeature enabled (withoutaws-lc-rsorrcgenfeatures).The failing doctests were:
src/crypto/provider.rsline 29 - usescertificateandaws_lc_rsmodulessrc/crypto/provider.rsline 307 - usesaws_lc_rsmodulesrc/crypto/provider.rsline 371 - usesaws_lc_rsmodulesrc/crypto/rust_crypto/mod.rsline 21 - usescertificatemoduleThese modules are gated behind
rcgenandaws-lc-rsfeatures respectively, causing compilation failures like:Changes
# if cfg!(feature = "...")blocksTest plan
test_features (ubuntu-latest, beta, rust-crypto)job🤖 Generated with Claude Code