task: fix unstable API documentation notes #4503
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
PR #4499 made the `JoinSet` API unstable, but did not add a documentation note explaining unstable features. This branch adds a note on unstable APIs to the `JoinSet` type-level documentation, similar to the notes for `task::Builder` and the runtime metrics APIs. Also, I noticed that there was a broken link to the top-level documentation on unstable APIs in the docs for `task::Builder`, so I fixed that as well.
hawkw
added
A-tokio
carllerche
approved these changes
Feb 15, 2022
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.
Motivation
PR #4499 made the
JoinSetAPI unstable, but did not add adocumentation note explaining unstable features. In general, since the
docs.rs build includes unstable APIs, it's probably worth including
these notes so that users understand what it means for an API to be
unstable.
Solution
This branch adds a note on unstable APIs to the
JoinSettype-leveldocumentation, similar to the notes for
task::Builderand the runtimemetrics APIs.
Also, I noticed that there was a broken link to the top-level
documentation on unstable APIs in the docs for
task::Builder, so Ifixed that as well.