Skip to content

Fix link for websockets documentation #2173

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 14, 2021
Merged

Fix link for websockets documentation #2173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e689999
Fix link for websockets documentation
fafrd Oct 6, 2021
75787fd
Set link to WebSocketClientProtocol
fafrd Oct 6, 2021
8cd2a76
Add newsfragment for websocket docs
kclowes Oct 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/providers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ WebsocketProvider
use the ``websocket_kwargs`` to do so. See the `websockets documentation`_ for
available arguments.

.. _`websockets documentation`: https://websockets.readthedocs.io/en/stable/api.html#websockets.protocol.WebSocketCommonProtocol
.. _`websockets documentation`: https://websockets.readthedocs.io/en/stable/reference/client.html#websockets.client.WebSocketClientProtocol

Unlike HTTP connections, the timeout for WS connections is controlled by a
separate ``websocket_timeout`` argument, as shown below.
Expand Down
1 change: 1 addition & 0 deletions newsfragments/2173.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Correct link to Websocket library documentation