doctests: correct configuration wrt crate features #1370
Merged
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
This is needed for docs.rs to include all features in the generated documentation. It seems that `scylla` crate has already been configured correctly, but `scylla-cql`, `scylla-macros`, and `scylla-proxy` were missing the needed setting. Also, I added quotes around the `docs.rs` metadata key to disambiguate it from the period that is used for nesting metadata keys.
The doc test for the `tls_context` method in `SessionBuilder` would fail when the `openssl-010` feature was disabled, because the feature was required to use the `openssl` crate required by the example. The changes are introduces as suggested here: https://users.rust-lang.org/t/doctests-that-require-a-non-default-feature-is-it-possible/29529/3 This makes all doc tests pass both when the `openssl-010` feature is enabled or disabled. Fixes: scylladb#1369
The test uses entities which may be unobvious to the reader. Their imports are made visible to aid understanding.
|
|
Lorak-mmk
approved these changes
Jun 4, 2025
Collaborator
Lorak-mmk
left a comment
Lorak-mmk
left a comment
There was a problem hiding this comment.
Thanks for the quick fix!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This patch fixes the unmet requirements for doctests wrt features:
SessionBuilder::tls_context()is compiled conditionally, only when the requiredopenssl-010feature is turned on;scylla-macros,scylla-cql, andscylla-proxynow have setall-featuresflag for docs.rs, which will make optional entities appear in those crates' respective docs. Before,#[cfg(feature)]'d entities would not show up in, e.g.,scylla-cqlcrate docs on docs.rs.Fixes: #1369
Pre-review checklist
[ ] I added relevant tests for new features and bug fixes.[ ] I have provided docstrings for the public items that I want to introduce.[ ] I have adjusted the documentation in./docs/source/.Fixes:annotations to PR description.