Minor updates to the server and client documentation

miguelgrinberg · Jun 19, 2024 · 5e78ecb · 5e78ecb
1 parent 469b7c0
commit 5e78ecb
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/src/socketio/async_client.py b/src/socketio/async_client.py
@@ -53,11 53,14 @@ class AsyncClient(base_client.BaseClient):
  :param http_session: an initialized ``aiohttp.ClientSession`` object to be
  used when sending requests to the server. Use it if
  you need to add special client options such as proxy
- servers, SSL certificates, etc.
  servers, SSL certificates, custom CA bundle, etc.
  :param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
  skip SSL certificate verification, allowing
  connections to servers with self signed certificates.
  The default is ``True``.
  :param websocket_extra_options: Dictionary containing additional keyword
  arguments passed to
  ``websocket.create_connection()``.
  :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
  a logger object to use. To disable logging set to
  ``False``. The default is ``False``. Note that

diff --git a/src/socketio/async_server.py b/src/socketio/async_server.py
@@ -102,6 102,9 @@ class AsyncServer(base_server.BaseServer):
  inactive clients are closed. Set to ``False`` to
  disable the monitoring task (not recommended). The
  default is ``True``.
  :param transports: The list of allowed transports. Valid transports
  are ``'polling'`` and ``'websocket'``. Defaults to
  ``['polling', 'websocket']``.
  :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
  a logger object to use. To disable logging set to
  ``False``. The default is ``False``. Note that

diff --git a/src/socketio/client.py b/src/socketio/client.py
@@ -56,11 56,14 @@ class Client(base_client.BaseClient):
  :param http_session: an initialized ``requests.Session`` object to be used
  when sending requests to the server. Use it if you
  need to add special client options such as proxy
- servers, SSL certificates, etc.
  servers, SSL certificates, custom CA bundle, etc.
  :param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
  skip SSL certificate verification, allowing
  connections to servers with self signed certificates.
  The default is ``True``.
  :param websocket_extra_options: Dictionary containing additional keyword
  arguments passed to
  ``websocket.create_connection()``.
  :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
  a logger object to use. To disable logging set to
  ``False``. The default is ``False``. Note that

diff --git a/src/socketio/server.py b/src/socketio/server.py
@@ -106,6 106,9 @@ class Server(base_server.BaseServer):
  inactive clients are closed. Set to ``False`` to
  disable the monitoring task (not recommended). The
  default is ``True``.
  :param transports: The list of allowed transports. Valid transports
  are ``'polling'`` and ``'websocket'``. Defaults to
  ``['polling', 'websocket']``.
  :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
  a logger object to use. To disable logging set to
  ``False``. The default is ``False``. Note that