doc: mark api elements gated behind a feature flag in rust doc#22
Merged
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #22 +/- ##
=======================================
Coverage 94.05% 94.05%
=======================================
Files 24 24
Lines 2272 2272
Branches 2272 2272
=======================================
Hits 2137 2137
Misses 129 129
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
rustdoc on nightly which is used by docs.rs to render API docs can mark API elements which are gated behind a crate feature with the required feature. With current Rust version this needs some configuration in the codebase.
API elements that are gated behind a crate feature have been configured to be document in rustdoc on nightly.
The Just-job for generating API docs (just doc) has been configured to tell rustdoc to generate the feature flags in the docs.