Update ping_timeout docs to accord with engineio behavior
#1255
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
See: https://github.com/miguelgrinberg/python-engineio/blob/5c996bec85d864526fe41569438a6e15e4a53123/src/engineio/async_server.py#L30-L32 https://github.com/miguelgrinberg/python-engineio/blob/5c996bec85d864526fe41569438a6e15e4a53123/src/engineio/server.py#L31-L33 Those docstrings correctly reflect the defaults, which are defined here: https://github.com/miguelgrinberg/python-engineio/blob/5c996bec85d864526fe41569438a6e15e4a53123/src/engineio/base_server.py#L22
|
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.
The stated default of
ping_timeoutis incorrect. This PR updates the docstring so that it accords with what is in engineio.The docstring says the default is 5s when it is actually 20s, as documented by engineio here and here
Those docstrings correctly reflect the defaults, which are defined in the constructor here.