[GH-ISSUE #1713] [resolver] Rustdoc for `AsyncResolver` incorrectly mentions a background future that needs to be spawned. #743

New issue

Open

opened 2026-03-16 00:06:57 +03:00 by kerem · 3 comments

kerem commented

2026-03-16 00:06:57 +03:00

Owner

Originally created by @abusch on GitHub (May 30, 2022).
Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1713

Describe the bug
Documentation for AsyncResolver, and most of its constructors, incorrectly says that a tuple of a resolver and a background future to spawn is returned.

To Reproduce
Steps to reproduce the behavior: see https://docs.rs/trust-dns-resolver/0.21.2/trust_dns_resolver/struct.AsyncResolver.html for instance.

Expected behavior
References to "a future that should be spawned on an executor to drive the background work" should be removed.

System:
n/a

Version:
Crate: resolver
Version: 0.21.2

Additional context
n/a

Originally created by @abusch on GitHub (May 30, 2022). Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1713 **Describe the bug** Documentation for `AsyncResolver`, and most of its constructors, incorrectly says that a tuple of a resolver and a background future to spawn is returned. **To Reproduce** Steps to reproduce the behavior: see https://docs.rs/trust-dns-resolver/0.21.2/trust_dns_resolver/struct.AsyncResolver.html for instance. **Expected behavior** References to "a future that should be spawned on an executor to drive the background work" should be removed. **System:** n/a **Version:** Crate: resolver Version: 0.21.2 **Additional context** n/a

kerem added the

docs

cleanup

labels

2026-03-16 00:06:57 +03:00

kerem commented

2026-03-16 00:07:08 +03:00

Author

Owner

@djc commented on GitHub (May 30, 2022):

Thanks for the report. Would you be interested in submitting a PR proposal?

@djc commented on GitHub (May 30, 2022): Thanks for the report. Would you be interested in submitting a PR proposal?

kerem commented

2026-03-16 00:07:13 +03:00

Author

Owner

@abusch commented on GitHub (May 30, 2022):

Sure, I'll give it a shot whenever i have a bit of time.

@abusch commented on GitHub (May 30, 2022): Sure, I'll give it a shot whenever i have a bit of time.

kerem commented

2026-03-16 00:07:18 +03:00

Author

Owner

@djc commented on GitHub (May 31, 2022):