aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-01-08 13:29:33 -0500
committerRapptz <[email protected]>2016-01-08 13:31:03 -0500
commit6d5175ad9aee4cf71bb268d062dfb27904390b3b (patch)
tree164d83df5b016c494c279d2ba151b4cfb3a7ea73
parentdocument public get_ methods and make others private (diff)
downloaddiscord.py-6d5175ad9aee4cf71bb268d062dfb27904390b3b.tar.xz
discord.py-6d5175ad9aee4cf71bb268d062dfb27904390b3b.zip
Document how Client.run should be the last function to call.
-rw-r--r--discord/client.py7
-rw-r--r--docs/migrating.rst7
2 files changed, 14 insertions, 0 deletions
diff --git a/discord/client.py b/discord/client.py
index 5c979128..4c06dcbf 100644
--- a/discord/client.py
+++ b/discord/client.py
@@ -759,7 +759,14 @@ class Client:
# cancel all tasks lingering
finally:
loop.close()
+
+ Warning
+ --------
+ This function must be the last function to call due to the fact that it
+ is blocking. That means that registration of events or anything being
+ called after this function call will not execute until it returns.
"""
+
try:
self.loop.run_until_complete(self.start(email, password))
except KeyboardInterrupt:
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: