Add documentation for custom websocket timeout

edikson · Aug 8, 2018 · 49dc10c · 49dc10c
1 parent 3ee20b5
commit 49dc10c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/binance/websockets.py b/binance/websockets.py
@@ -73,6 +73,8 @@ def __init__(self, client, user_timeout=DEFAULT_USER_TIMEOUT):
 
         :param client: Binance API client
         :type client: binance.Client
+        :param user_timeout: Custom websocket timeout
+        :type user_timeout: int
 
         """
         threading.Thread.__init__(self)

diff --git a/docs/websockets.rst b/docs/websockets.rst
@@ -37,6 +37,13 @@ A callback to process messages would take the format
         print(msg)
         # do something
 
+Set a custom timeout for the websocket connection
+
+.. code:: python
+
+    # set a timeout of 60 seconds
+    bm = BinanceSocketManager(client, user_timeout=60)
+
 
 Websocket Errors
 ----------------