rt: make JoinSet unstable
#4499
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
There are still some open questions related to the API. Until they are resolved, the type should be marked as unstable so releases are not blocked.
Darksonn
approved these changes
Feb 14, 2022
hawkw
approved these changes
Feb 14, 2022
There was a problem hiding this comment.
We should probably also add a note in the JoinSet docs that it's unstable, and link to the documentation on unstable features, like the way we do for task::Builder etc:
tokio/tokio/src/task/builder.rs
Lines 7 to 9 in 8fb15da
Once that's added, this looks good to me!
|
@carllerche mind making the docs change i suggested so we can merge this? thanks! |
Noah-Kennedy
approved these changes
Feb 14, 2022
hawkw
added a commit
that referenced
this pull request
Feb 15, 2022
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 commit
that referenced
this pull request
Feb 15, 2022
## Motivation PR #4499 made the `JoinSet` API unstable, but did not add a documentation 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 `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.
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.
There are still some open questions related to the API. Until they are
resolved, the type should be marked as unstable so releases are not
blocked.
Specifically, how can tasks spawned onto the
JoinSetbe canceled?My inclination would be to return an
AbortHandlefromJoinSet::spawn.