Skip to content

Minor: Fix docs for JoinSet #23448

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

Merged
alamb merged 2 commits into from
Jul 10, 2026
Merged

Minor: Fix docs for JoinSet #23448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20919c7
Minor: Fix docs for JoinSet
alamb Jul 10, 2026
051dd73
Apply suggestion from @alamb
alamb Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions datafusion/common-runtime/src/join_set.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ use std::task::{Context, Poll};
use tokio::runtime::Handle;
use tokio::task::{AbortHandle, Id, JoinError, LocalSet};

/// A wrapper around Tokio's JoinSet that forwards all API calls while optionally
/// A wrapper around [Tokio's `JoinSet`] that forwards all API calls while optionally
/// instrumenting spawned tasks and blocking closures with custom tracing behavior.
/// If no tracer is injected via `trace_utils::set_tracer`, tasks and closures are executed
/// If no tracer is injected via [`set_join_set_tracer`], tasks and closures are executed
/// without any instrumentation.
///
/// [Tokio's `JoinSet`]: tokio::task::JoinSet
/// [`set_join_set_tracer`]: crate::trace_utils::set_join_set_tracer
#[derive(Debug)]
pub struct JoinSet<T> {
inner: tokio::task::JoinSet<T>,
Expand Down
Loading