aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2019-04-18 20:04:11 -0400
committerRapptz <[email protected]>2019-04-18 20:04:11 -0400
commitceb154718d0dfffb65e3cc30a6c3e30150cf83dc (patch)
treeea307238874deb75cb13b3a88d1c191903664df8
parentMake context documentation in migration a bit more clear. (diff)
downloaddiscord.py-ceb154718d0dfffb65e3cc30a6c3e30150cf83dc.tar.xz
discord.py-ceb154718d0dfffb65e3cc30a6c3e30150cf83dc.zip
Add note about overriding Client.close vs Client.logout
-rw-r--r--discord/client.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/discord/client.py b/discord/client.py
index 2f70082b..465b9b14 100644
--- a/discord/client.py
+++ b/discord/client.py
@@ -389,6 +389,12 @@ class Client:
"""|coro|
Logs out of Discord and closes all connections.
+
+ .. note::
+
+ This is just an alias to :meth:`close`. If you want
+ to do extraneous cleanup when subclassing, it is suggested
+ to override :meth:`close` instead.
"""
await self.close()