From 4f5bf1e9898154aa1a9896a7016ba22bfb73cdf2 Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Fri, 15 Oct 2021 23:38:39 +0100 Subject: [PATCH] Improve documentation on start_background_task() function --- src/socketio/asyncio_client.py | 4 +--- src/socketio/asyncio_server.py | 2 -- src/socketio/client.py | 6 +++--- src/socketio/server.py | 6 +++--- 4 files changed, 7 insertions(+), 11 deletions(-) diff --git a/src/socketio/asyncio_client.py b/src/socketio/asyncio_client.py index 461e96f..7409505 100644 --- a/src/socketio/asyncio_client.py +++ b/src/socketio/asyncio_client.py @@ -311,9 +311,7 @@ class AsyncClient(client.Client): :param args: arguments to pass to the function. :param kwargs: keyword arguments to pass to the function. - This function returns an object compatible with the `Thread` class in - the Python standard library. The `start()` method on this object is - already called by this function. + The return value is a ``asyncio.Task`` object. """ return self.eio.start_background_task(target, *args, **kwargs) diff --git a/src/socketio/asyncio_server.py b/src/socketio/asyncio_server.py index 7e1b889..4441079 100644 --- a/src/socketio/asyncio_server.py +++ b/src/socketio/asyncio_server.py @@ -396,8 +396,6 @@ class AsyncServer(server.Server): :param kwargs: keyword arguments to pass to the function. The return value is a ``asyncio.Task`` object. - - Note: this method is a coroutine. """ return self.eio.start_background_task(target, *args, **kwargs) diff --git a/src/socketio/client.py b/src/socketio/client.py index b30fea7..9a00dbc 100644 --- a/src/socketio/client.py +++ b/src/socketio/client.py @@ -500,9 +500,9 @@ class Client(object): :param args: arguments to pass to the function. :param kwargs: keyword arguments to pass to the function. - This function returns an object compatible with the `Thread` class in - the Python standard library. The `start()` method on this object is - already called by this function. + This function returns an object that represents the background task, + on which the ``join()`` methond can be invoked to wait for the task to + complete. """ return self.eio.start_background_task(target, *args, **kwargs) diff --git a/src/socketio/server.py b/src/socketio/server.py index d4dd22f..5b070d5 100644 --- a/src/socketio/server.py +++ b/src/socketio/server.py @@ -599,9 +599,9 @@ class Server(object): :param args: arguments to pass to the function. :param kwargs: keyword arguments to pass to the function. - This function returns an object compatible with the `Thread` class in - the Python standard library. The `start()` method on this object is - already called by this function. + This function returns an object that represents the background task, + on which the ``join()`` methond can be invoked to wait for the task to + complete. """ return self.eio.start_background_task(target, *args, **kwargs)