diff options
| author | engn33r <engn33r@users.noreply.github.com> | 2021-03-31 18:17:32 -0700 |
|---|---|---|
| committer | engn33r <engn33r@users.noreply.github.com> | 2021-03-31 18:17:32 -0700 |
| commit | 910e6e14c64a664c3432db2f5fd9f1395dc9e7f7 (patch) | |
| tree | ecf7793629fb590844e293ccc3243034bb22a06a | |
| parent | 2bdda8a76993d1aefa9926579f2b83e8f34c22c7 (diff) | |
| download | websocket-client-910e6e14c64a664c3432db2f5fd9f1395dc9e7f7.tar.gz | |
Minor documentation update
| -rw-r--r-- | docs/source/examples.rst | 1 | ||||
| -rw-r--r-- | docs/source/faq.rst | 8 | ||||
| -rw-r--r-- | docs/source/threading.rst | 3 |
3 files changed, 9 insertions, 3 deletions
diff --git a/docs/source/examples.rst b/docs/source/examples.rst index 834051b..867f2e7 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -484,6 +484,7 @@ a few of the projects using websocket-client are listed below: - `https://github.com/slackapi/python-slack-sdk <https://github.com/slackapi/python-slack-sdk>`_ - `https://github.com/wee-slack/wee-slack <https://github.com/wee-slack/wee-slack>`_ - `https://github.com/aluzzardi/wssh/ <https://github.com/aluzzardi/wssh/>`_ +- `https://github.com/llimllib/limbo <https://github.com/llimllib/limbo>`_ - `https://github.com/miguelgrinberg/python-socketio <https://github.com/miguelgrinberg/python-socketio>`_ - `https://github.com/invisibleroads/socketIO-client <https://github.com/invisibleroads/socketIO-client>`_ - `https://github.com/s4w3d0ff/python-poloniex <https://github.com/s4w3d0ff/python-poloniex>`_ diff --git a/docs/source/faq.rst b/docs/source/faq.rst index 2af4944..4b2280d 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -6,8 +6,12 @@ Why is this library slow? =========================== The ``send`` and ``validate_utf8`` methods are very slow in pure Python. -If you want to get better performance, please install both numpy and wsaccel. -Note that wsaccel can sometimes cause other issues. +You can disable UTF8 validation in this library (and receive a +performance enhancement) with the ``skip_utf8_validation`` parameter. +If you want to get better performance, please install both numpy and +wsaccel, and import them into your project files - these external +libraries will automatically be used when available. Note that +wsaccel can sometimes cause other issues. How to solve the "connection is already closed" error? =========================================================== diff --git a/docs/source/threading.rst b/docs/source/threading.rst index 4ecdeab..7125563 100644 --- a/docs/source/threading.rst +++ b/docs/source/threading.rst @@ -92,7 +92,8 @@ ws://echo.websocket.org, do not trigger the ``on_close()`` function. wsapp = websocket.WebSocketApp("wss://api.bitfinex.com/ws/1", on_open=on_open, on_message=on_message, on_close=on_close) wsapp.run_forever() - +TODO: Add an example of using ws.recv() in a non-blocking manner, as asked in +`issue #416 <https://github.com/websocket-client/websocket-client/issues/416>`_ In part because threading is hard, but also because this project has (until recently) lacked any threading documentation, there are many issues on this topic, including: |