docs: Add labels for optional features #404
Merged
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
✅ Deploy Preview for aya-rs-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
|
dave-tucker
force-pushed
the
async-docs
branch
from
0ca7cc7
to
245f806
Compare
vadorovsky
approved these changes
Oct 4, 2022
Merged
Following the lead of crates like tokio and nix, we now annotate APIs that require optional features. This helps in cases where a user wants to have an `AsyncPerfEventArray` which is documented on crates.io, but it's not obvious that you have to enable the `async` feature. Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
dave-tucker
force-pushed
the
async-docs
branch
from
245f806
to
95e8c78
Compare
vadorovsky
approved these changes
Oct 5, 2022
dave-tucker
added
documentation
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.
Following the lead of crates like tokio and nix, we now annotate APIs that require optional features. This helps in cases where a user wants to have an
AsyncPerfEventArraywhich is documented on crates.io, but it's not obvious that you have to enable theasyncfeature.Signed-off-by: Dave Tucker dave@dtucker.co.uk