docs: clarify Pool::size and Pool::num_idle - #4398
Open
valentynkit wants to merge 1 commit into
Open
Conversation
`num_idle` was documented as returning connections "active and idle", which reads as active plus idle. It only counts idle ones. `size` was documented as "currently active. This includes idle connections" which is incomplete: `try_increment_size()` bumps the counter before the connection is established, so connections still being opened are counted too.
valentynkit
marked this pull request as ready for review
August 28, 2026 12:33
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
num_idlewas documented as returning connections "active and idle", but it only counts idle ones. So the docs were confusing. Drop the mention of active.sizewas documented as "currently active. This includes idle connections" which is incomplete and sound strange (idle are not part of active, so should beand).try_increment_size()bumps the counter before the connection is established, so connections still being opened are counted too (nitty detail, but may be worth mentioning).