From 10fda00b92f4b92bc46af9cea2682de35f7c23e0 Mon Sep 17 00:00:00 2001 From: fselmo Date: Thu, 25 Jan 2024 10:07:46 -0700 Subject: [PATCH] Update documentation for ``WebsocketProviderV2`` --- docs/providers.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/providers.rst b/docs/providers.rst index d0e365722b..71c8f8cf2a 100644 --- a/docs/providers.rst +++ b/docs/providers.rst @@ -226,7 +226,7 @@ WebsocketProviderV2 (beta) and supported and is expected to be stable in the next major version of *web3.py* (v7). -.. py:class:: web3.providers.websocket.WebsocketProviderV2(endpoint_uri, websocket_kwargs, call_timeout) +.. py:class:: web3.providers.websocket.WebsocketProviderV2(endpoint_uri, websocket_kwargs, silence_listener_task_exceptions) This provider handles interactions with an WS or WSS based JSON-RPC server. @@ -234,8 +234,9 @@ WebsocketProviderV2 (beta) ``'ws://localhost:8546'``. * ``websocket_kwargs`` this should be a dictionary of keyword arguments which will be passed onto the ws/wss websocket connection. - * ``request_timeout`` is the timeout in seconds, as a float. Used when receiving or - sending data over the connection. This value defaults to 20 seconds. + * ``silence_listener_task_exceptions`` is a boolean that determines whether + exceptions raised by the listener task are silenced. Defaults to ``False``, + raising any exceptions that occur in the listener task. Under the hood, the ``WebsocketProviderV2`` uses the python websockets library for making requests. If you would like to modify how requests are made, you can