diff options
author | bubbleboy14 <mario.balibrera@gmail.com> | 2023-01-20 13:14:23 -0800 |
---|---|---|
committer | bubbleboy14 <mario.balibrera@gmail.com> | 2023-01-20 13:14:23 -0800 |
commit | be4110c08c5d10b52410c36c72d1deb9e4cbf32c (patch) | |
tree | d6dddc00338bc416ba72e7de629dd170270ddb8f /docs | |
parent | 7d83cc3e559526ca2d6774768baffc19ff14f8da (diff) | |
parent | 601a9022d6044bf6d414fdb1122916b65dc58ca7 (diff) | |
download | websocket-client-t858.tar.gz |
Merge branch 'master' into t858t858
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/conf.py | 2 | ||||
-rw-r--r-- | docs/source/examples.rst | 4 | ||||
-rw-r--r-- | docs/source/getting_started.rst | 3 | ||||
-rw-r--r-- | docs/source/threading.rst | 2 |
4 files changed, 5 insertions, 6 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 1d49533..a07281f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,7 @@ copyright = '2022' author = 'liris' # The full version, including alpha/beta/rc tags -release = '1.4.1' +release = '1.4.2' # -- General configuration --------------------------------------------------- diff --git a/docs/source/examples.rst b/docs/source/examples.rst index d3d5b99..9b3a905 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -700,7 +700,7 @@ You can use an asynchronous dispatcher such as `rel <https://pypi.org/project/re >>> addr = "wss://api.gemini.com/v1/marketdata/%s" >>> for symbol in ["BTCUSD", "ETHUSD", "ETHBTC"]: ... ws = websocket.WebSocketApp(addr % (symbol,), on_message=lambda w, m : print(m)) - ... ws.run_forever(dispatcher=rel) # doctest: +SKIP + ... ws.run_forever(dispatcher=rel, reconnect=3) # doctest: +SKIP >>> rel.signal(2, rel.abort) # Keyboard Interrupt # doctest: +SKIP >>> rel.dispatch() # doctest: +SKIP @@ -739,7 +739,7 @@ The examples are found in the README and are copied here for sphinx doctests to ... on_error=on_error, ... on_close=on_close) - >>> ws.run_forever(dispatcher=rel) # Set dispatcher to automatic reconnection # doctest: +SKIP + >>> ws.run_forever(dispatcher=rel, reconnect=5) # Set dispatcher to automatic reconnection, 5 second reconnect delay if connection closed unexpectedly # doctest: +SKIP >>> rel.signal(2, rel.abort) # Keyboard Interrupt <Signal Object | Callback:"abort"> >>> rel.dispatch() # doctest: +SKIP diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 5f3e3f6..c69a1e7 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -12,8 +12,7 @@ For an easy example, run the following: The above command will provide you with an interactive terminal to communicate with the echo.websocket.events server. This server will echo back any message you -send it. You can test this WebSocket connection in your browser, without this -library, by visiting the URL https://websocket.org/echo.html. +send it. The wsdump.py script has many additional options too, so it's a great way to try using this library without writing any custom code. The output of diff --git a/docs/source/threading.rst b/docs/source/threading.rst index 51a74af..7870e71 100644 --- a/docs/source/threading.rst +++ b/docs/source/threading.rst @@ -60,7 +60,7 @@ trigger the ``on_close()`` function. The highlighted rows show the lines added exclusively in the second example. This threading approach is identical to the `echoapp_client.py example <https://github.com/websocket-client/websocket-client/blob/master/examples/echoapp_client.py>`_. However, further testing found that some WebSocket servers, such as -ws://echo.websocket.org, do not trigger the ``on_close()`` function. +ws://echo.websocket.events, do not trigger the ``on_close()`` function. **NOT working on_close() example, without threading** |