Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: JoinSet::try_join_next() returns None when no tasks are completed #6671

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Doc: JoinSet::try_join_next() returns None when no tasks are completed #6671

merged 1 commit into from
Jul 2, 2024

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Jul 2, 2024

Motivation

The documentation of JoinSet's try_join_next() and try_join_next_with_id() doesn't say what happens if there are no completed tasks.

join_next() waits, but try_join_next() appears to return None immediately.

Solution

Update the docs for both methods.

Darksonn
Darksonn approved these changes Jul 2, 2024
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-task Module: tokio/task labels Jul 2, 2024
@Darksonn Darksonn merged commit 4d0d89f into tokio-rs:master Jul 2, 2024
82 checks passed
This was referenced Jul 22, 2024
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn approved these changes

Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate M-task Module: tokio/task T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@teor2345 @Darksonn