Update README timeout #3115
Merged
Update README timeout #3115
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
|
Reads pretty good |
|
I am still confused with the timeout doc. Does the value apply to both bullet points (read timeout and connection timeout)? Or can it set different value to them? |
|
@lalau "integer containing number of milliseconds, controls two timeouts." then those two timeouts are listed below. So yes, it applies to both. I think it makes sense now but maybe you have a suggestion for further clarity? |
sthnaqvi
added a commit
to sthnaqvi/request
that referenced
this pull request
Mar 31, 2019
docs: adjust readme timeout argument description to be clearer (request#3115)
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.
PR Checklist:
npm testlocally and all tests are passing.PR Description
Timeout argument description is currently very misleading. It was split into two bullets here but the note regarding OS-wide timeout does not apply to the first bullet, but rather the second. In addition, this change made the wording more confusing, in my opinion. I reverted it back to what it was originally.