diff options
| author | Rapptz <[email protected]> | 2015-11-26 23:59:16 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2015-11-26 23:59:16 -0500 |
| commit | e75edc2e57f2701fd6505fa74488c2b65b59b955 (patch) | |
| tree | 5fb95ee61c290ed3b2214a6be0b05ac4eed2302c | |
| parent | Revert "GIF support for avatars" (diff) | |
| download | discord.py-e75edc2e57f2701fd6505fa74488c2b65b59b955.tar.xz discord.py-e75edc2e57f2701fd6505fa74488c2b65b59b955.zip | |
Document Client.run reconnection idiosyncrasy.
| -rw-r--r-- | discord/client.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/discord/client.py b/discord/client.py index c9b5d9c6..c5d44a6c 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() |