Skip to content

Commit 844c62e

Browse files
authored
Minor: Fix docs for JoinSet (#23448)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - related to #22758 ## Rationale for this change While responding on #22758 (comment) to @avantgardnerio I noticed that the reference in the doc is wrong (and not a link) ## What changes are included in this PR? Fix doc links ## Are these changes tested? By CI ## Are there any user-facing changes? Docs
1 parent 63e25c1 commit 844c62e

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

datafusion/common-runtime/src/join_set.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,13 @@ use std::task::{Context, Poll};
2121
use tokio::runtime::Handle;
2222
use tokio::task::{AbortHandle, Id, JoinError, LocalSet};
2323

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

0 commit comments

Comments
 (0)