Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation's recommended value for disabling connection_timeout behavior #21

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mparent61
Copy link

@mparent61 mparent61 commented Sep 8, 2022

The documentation for disabling the connection_timeout functionality incorrectly says to use None, which fails MyPy type checking.

According to the aiocometd source 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 0 as the "disable timeout" value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant