Skip to content

Commit

Permalink
Improve documentation on start_background_task() function
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgrinberg committed Oct 15, 2021
1 parent bd6a0e2 commit a10ea5c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/flask_socketio/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -690,9 +690,9 @@ def start_background_task(self, target, *args, **kwargs):
: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.server.start_background_task(target, *args, **kwargs)

Expand Down

0 comments on commit a10ea5c

Please sign in to comment.