From e75edc2e57f2701fd6505fa74488c2b65b59b955 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Thu, 26 Nov 2015 23:59:16 -0500 Subject: [PATCH] Document Client.run reconnection idiosyncrasy. --- discord/client.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/discord/client.py b/discord/client.py index c9b5d9c66..c5d44a6ce 100644 --- a/discord/client.py +++ b/discord/client.py @@ -573,7 +573,14 @@ class Client(object): """Runs the client and allows it to receive messages and events. This function can raise a :exc:`GatewayNotFound` exception while attempting - to reconnect.""" + to reconnect. + + .. note:: + + This function attempts to reconnect if the websocket got closed + without explicitly calling :meth:`logout`. When this reconnect is + triggered, the :func:`discord.on_ready` event is called again. + """ log.info('Client is being run') self.ws.run()