Fix documentation's recommended value for disabling connection_timeout behavior#21
Open
mparent61 wants to merge 1 commit intorobertmrk:developfrom
Open
Fix documentation's recommended value for disabling connection_timeout behavior#21mparent61 wants to merge 1 commit intorobertmrk:developfrom
connection_timeout behavior#21mparent61 wants to merge 1 commit intorobertmrk:developfrom
Conversation
This file contains hidden or 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
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 documentation for disabling the
connection_timeoutfunctionality incorrectly says to useNone, which fails MyPy type checking.According to the
aiocometdsource code, this value must be an Integer or Float type:https://github.com/robertmrk/aiocometd/blob/0.4.5/aiocometd/client.py#L42
And any "falsey" value will suffice here, as the logic to enable the timeout uses a
if connection_timeout:conditional - https://github.com/robertmrk/aiocometd/blob/0.4.5/aiocometd/client.py#L458-L463.So I've updated the documentation to specify
0as the "disable timeout" value.