More accurate logging documentation (Fixes #158)

miguelgrinberg · Feb 14, 2020 · 5260f5c · 5260f5c
1 parent 7ca9697
commit 5260f5c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/engineio/asyncio_client.py b/engineio/asyncio_client.py
@@ -22,7 +22,8 @@ class AsyncClient(client.Client):
 
     :param logger: To enable logging set to ``True`` or pass a logger object to
                    use. To disable logging set to ``False``. The default is
-                   ``False``.
+                   ``False``. Note that fatal errors are logged even when
+                   ``logger`` is ``False``.
     :param json: An alternative json module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library

diff --git a/engineio/asyncio_server.py b/engineio/asyncio_server.py
@@ -49,7 +49,8 @@ class AsyncServer(server.Server):
     :param cors_credentials: Whether credentials (cookies, authentication) are
                              allowed in requests to this server.
     :param logger: To enable logging set to ``True`` or pass a logger object to
-                   use. To disable logging set to ``False``.
+                   use. To disable logging set to ``False``. Note that fatal
+                   errors are logged even when ``logger`` is ``False``.
     :param json: An alternative json module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library

diff --git a/engineio/client.py b/engineio/client.py
@@ -57,7 +57,8 @@ class Client(object):
 
     :param logger: To enable logging set to ``True`` or pass a logger object to
                    use. To disable logging set to ``False``. The default is
-                   ``False``.
+                   ``False``. Note that fatal errors are logged even when
+                   ``logger`` is ``False``.
     :param json: An alternative json module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library

diff --git a/engineio/server.py b/engineio/server.py
@@ -61,7 +61,8 @@ class Server(object):
                              is ``True``.
     :param logger: To enable logging set to ``True`` or pass a logger object to
                    use. To disable logging set to ``False``. The default is
-                   ``False``.
+                   ``False``. Note that fatal errors are logged even when
+                   ``logger`` is ``False``.
     :param json: An alternative json module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library