From 6d5175ad9aee4cf71bb268d062dfb27904390b3b Mon Sep 17 00:00:00 2001 From: Rapptz Date: Fri, 8 Jan 2016 13:29:33 -0500 Subject: Document how Client.run should be the last function to call. --- docs/migrating.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/migrating.rst') diff --git a/docs/migrating.rst b/docs/migrating.rst index caf15d67..2cfa2bc6 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -262,6 +262,13 @@ After: client.run('email', 'password') +.. warning:: + + Like in the older ``Client.run`` function, the newer one must be the one of + the last functions to call. This is because the function is **blocking**. Registering + events or doing anything after :meth:`Client.run` will not execute until the function + returns. + This is a utility function that abstracts the event loop for you. There's no need for the run call to be blocking and out of your control. Indeed, if you want control of the event loop then doing so is quite straightforward: -- cgit v1.2.3