Explicitly state max_connections and timeout defaults in docs #688
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
benoitc
requested changes
Jun 17, 2021
README.md
Outdated
| @@ -368,7 +368,7 @@ ok = hackney_pool:start_pool(PoolName, Options), | |||
| `timeout` is the time we keep the connection alive in the pool, | |||
| `max_connections` is the number of connections maintained in the pool. Each | |||
| connection in a pool is monitored and closed connections are removed | |||
| automatically. | |||
| automatically. The default timeout is `150000` and the default number of connections is `50`. | |||
There was a problem hiding this comment.
Can you add the unit to the timeout? ie. 150000 ms sot it would definitely clarify the text
sbinlondon
force-pushed
the
sbinlondon/docs
branch
from
7b5d345
to
10fe6ce
Compare
|
@benoitc let me know if that new formatting is ok or if you want any more changes. |
|
finally merged. Thanks! |
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.
There's no explicitly stated defaults (that I can find) for
max_connectionsandtimeout.The README examples, if they are examples of the defaults, say
100formax_connectionsbut then inhackney.app.srcit seems to be50? I went with that one but if it is something else, please let me know and happy to update my PR.Either way it would be helpful to have very clearly stated defaults.