This is an automated email from the ASF dual-hosted git repository.
mneumann pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs-object-store.git
The following commit(s) were added to refs/heads/main by this push:
new 0af53d9 Clarify ShuffleResolver doc-comments (#645)
0af53d9 is described below
commit 0af53d9424b2a29af0f49942420a19ada45dc5ec
Author: Joseph Koshakow <[email protected]>
AuthorDate: Wed Feb 18 05:33:56 2026 -0500
Clarify ShuffleResolver doc-comments (#645)
This commit clarifies the ShuffleResolver doc-comments in two places by
adding some additional details.
---
src/client/dns.rs | 2 +-
src/client/mod.rs | 8 ++++++++
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/client/dns.rs b/src/client/dns.rs
index 32e9291..b1abe59 100644
--- a/src/client/dns.rs
+++ b/src/client/dns.rs
@@ -29,7 +29,7 @@ pub(crate) struct ShuffleResolver;
impl Resolve for ShuffleResolver {
fn resolve(&self, name: Name) -> Resolving {
Box::pin(async move {
- // use `JoinSet` to propagate cancelation
+ // use `JoinSet` to propagate cancelation to tasks that haven't
started running yet.
let mut tasks = JoinSet::new();
tasks.spawn_blocking(move || {
let it = (name.as_str(), 0).to_socket_addrs()?;
diff --git a/src/client/mod.rs b/src/client/mod.rs
index bc8c27e..d559d3c 100644
--- a/src/client/mod.rs
+++ b/src/client/mod.rs
@@ -174,6 +174,14 @@ pub enum ClientConfigKey {
///
/// This will spread the connections across more servers.
///
+ /// <div class="warning">
+ ///
+ /// **Warning**
+ ///
+ /// This will override the DNS resolver configured by [`reqwest`].
+ ///
+ /// </div>
+ ///
/// Supported keys:
/// - `randomize_addresses`
RandomizeAddresses,
