Add description of timeout values #78
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
add changelog
dblock
reviewed
Jul 16, 2020
README.md
Outdated
| @@ -17,6 +17,8 @@ gem 'graphlient' | |||
|
|
|||
| Create a new instance of `Graphlient::Client` with a URL and optional headers/http_options. | |||
|
|
|||
| >timeout values are set in seconds | |||
There was a problem hiding this comment.
Can we document the fields below in a table instead? It's unclear what the defaults are, if any, and then whether these are seconds or ms or something else.
There was a problem hiding this comment.
Great idea, totally agree!
I have updated the readme, could you check it again please?
* 'master' of github.com:sap1enza/graphlient: Update CHANGELOG.md
|
Thank you, 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.
WHAT
I was in doubt if the timeout values were in miliseconds or seconds, I confirmed checking one issue which mentioned the default value was in seconds #51 (comment)
I think is a good option to make this information explicit