Rename PoolLimits to Limits #1113
Merged
Conversation
This file contains 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
florimondmanca
commented
Aug 1, 2020
| @@ -418,8 +419,7 @@ class Client(BaseClient): | |||
| URLs. | |||
| * **timeout** - *(optional)* The timeout configuration to use when sending | |||
| requests. | |||
| * **pool_limits** - *(optional)* The connection pool configuration to use | |||
| when determining the maximum number of concurrently open HTTP connections. | |||
| * **limits** - *(optional)* The limits configuration to use. | |||
There was a problem hiding this comment.
Haven't found a better description of the parameter that's not redundant with the info in the Limits docstring. I don't think it's included in the Developer Interface yet so that could be a nice follow-up, and then cross-link it here?
There was a problem hiding this comment.
I guess we could say something like... "Allows for configuration options, such as the maximum number of open connections to allow." Just to give a bit of an indication what we mean by "limits" here(?)
There was a problem hiding this comment.
Let's pull this in for now as it is. Welcome to follow up with docstring improvements later.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1094
Change the following with gentle deprecation:
httpx.PoolLimits(...)becomeshttpx.Limits(...)Client(pool_limits=...)becomesClient(limits=...)AsyncClient(pool_limits=...)becomesAsyncClient(limits=...)