Fix documentation for max_http_buffer_size (#310)

miguelgrinberg · Feb 23, 2023 · 8182f78 · 8182f78
1 parent 5e01de4
commit 8182f78
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/src/engineio/asyncio_server.py b/src/engineio/asyncio_server.py
@@ -30,9 +30,8 @@ class AsyncServer(server.Server):
     :param ping_timeout: The time in seconds that the client waits for the
                          server to respond before disconnecting. The default
                          is 20 seconds.
-    :param max_http_buffer_size: The maximum size of a message when using the
-                                 polling transport. The default is 1,000,000
-                                 bytes.
+    :param max_http_buffer_size: The maximum size of a message.  The default
+                                 is 1,000,000 bytes.
     :param allow_upgrades: Whether to allow transport upgrades or not.
     :param http_compression: Whether to compress packages when using the
                              polling transport.

diff --git a/src/engineio/server.py b/src/engineio/server.py
@@ -37,9 +37,8 @@ class Server(object):
     :param ping_timeout: The time in seconds that the client waits for the
                          server to respond before disconnecting. The default
                          is 20 seconds.
-    :param max_http_buffer_size: The maximum size of a message when using the
-                                 polling transport. The default is 1,000,000
-                                 bytes.
+    :param max_http_buffer_size: The maximum size of a message.  The default
+                                 is 1,000,000 bytes.
     :param allow_upgrades: Whether to allow transport upgrades or not. The
                            default is ``True``.
     :param http_compression: Whether to compress packages when using the