summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorengn33r <engn33r@users.noreply.github.com>2021-05-31 18:35:40 -0400
committerengn33r <engn33r@users.noreply.github.com>2021-05-31 18:35:40 -0400
commitb0906644709906cceccf658f28f78246c2ac8687 (patch)
tree7d566afe68087a02b67923053af3c981f8936cee /docs/source
parent287970efa70adc6224a3f055351a04a4fdaea526 (diff)
downloadwebsocket-client-b0906644709906cceccf658f28f78246c2ac8687.tar.gz
Improve wsaccel/numpy docs and code coverage
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/faq.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index 366b670..ea14bb5 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -16,8 +16,10 @@ 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.
+libraries will automatically be used when available. wsaccel
+doubles the speed of UTF8 validation while both numpy and wsaccel
+offer a minor performance boost when masking the payload data as
+part of the ``send`` process.
How to solve the "connection is already closed" error?
===========================================================