docs: Expose feature-gated APIs with doc(cfg) #346
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
APIs hidden behind features can now be viewed on docs.rs! All feature-gated modules and structs should be annotated with a note that mentions the specific feature flag needed to use the corresponding API. This primarily fixes a linter warning regarding a link to a nonexistent integration which was gated behind a feature. There are other small fixes as well, mostly just hooking up links that weren't assigned destinations. While the doc feature is considered unstable, we're taking advantage of the fact that docs are built with nightly by default.
Swatinem
approved these changes
Jun 22, 2021
flub
approved these changes
Jun 22, 2021
Codecov Report
@@ Coverage Diff @@
## master #346 +/- ##
==========================================
+ Coverage 83.08% 86.58% +3.50%
==========================================
Files 62 66 +4
Lines 6478 6838 +360
==========================================
+ Hits 5382 5921 +539
+ Misses 1096 917 -179 |
Tuetuopay
pushed a commit
to Tuetuopay/sentry-rust
that referenced
this pull request
Jul 5, 2021
APIs hidden behind features can now be viewed on docs.rs! All feature-gated modules and structs should be annotated with a note that mentions the specific feature flag needed to use the corresponding API. This primarily fixes a linter warning regarding a link to a nonexistent integration which was gated behind a feature. There are other small fixes as well, mostly just hooking up links that weren't assigned destinations. While the doc feature is considered unstable, we're taking advantage of the fact that docs are built with nightly by default.
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.
APIs hidden behind features can now be viewed on docs.rs! All feature-gated modules and structs should be annotated with a note that mentions the specific feature flag needed to use the corresponding API.
This primarily fixes a linter warning regarding a link to a nonexistent integration which was gated behind a feature. There are other small fixes as well, mostly just hooking up links that weren't assigned destinations.
While the doc feature is considered unstable, we're taking advantage of the fact that docs are built with nightly by default.