This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 844c62e55f Minor: Fix docs for JoinSet (#23448)
844c62e55f is described below
commit 844c62e55fec4e299d7dc7c77bc05c9bdcadd77c
Author: Andrew Lamb <[email protected]>
AuthorDate: Fri Jul 10 16:03:07 2026 -0400
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 https://github.com/apache/datafusion/issues/22758
## Rationale for this change
While responding on
https://github.com/apache/datafusion/issues/22758#issuecomment-4937571363
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
---
datafusion/common-runtime/src/join_set.rs | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/datafusion/common-runtime/src/join_set.rs
b/datafusion/common-runtime/src/join_set.rs
index 1857a4111d..3ac5912243 100644
--- a/datafusion/common-runtime/src/join_set.rs
+++ b/datafusion/common-runtime/src/join_set.rs
@@ -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>,
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
