docs: document connection pooling behavior #2851
Merged
+10
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add connection pooling section to Client struct docs and update pool_idle_timeout and pool_max_idle_per_host methods.
seanmonstar
requested changes
Nov 3, 2025
Owner
seanmonstar
left a comment
seanmonstar
left a comment
There was a problem hiding this comment.
Thanks for taking the time to improve the docs!
I reminded myself what that issue said, and yea, I'd be happy with adding a sub section to the struct docs. I suspect that is sufficient...
src/async_impl/client.rs
Outdated
| /// # Connection Pooling | ||
| /// | ||
| /// The Client maintains a pool of reusable HTTP connections to avoid | ||
| /// connection setup overhead. |
Owner
There was a problem hiding this comment.
There's a sentence a few lines up saying similar. What if we took the essence of that line ("holds a connection pool internally"), and merged it with this one?
Contributor
Author
There was a problem hiding this comment.
Good point! Merged them to avoid redundancy.
Contributor
Author
|
Thanks for the feedback! I've addressed all your comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #2500
Added documentation to clarify the current behavior and limitations.
Changes:
Happy to adjust based on feedback!