diff options
| author | Sebastian Law <[email protected]> | 2021-02-20 17:47:29 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-02-20 20:47:29 -0500 |
| commit | b86073fac3776cfc64f9bce07cbd51368ca2c836 (patch) | |
| tree | ad931badf396535e7ac1cef4b9cce76b25e00e64 /docs | |
| parent | Add User.mutual_guilds (diff) | |
| download | discord.py-b86073fac3776cfc64f9bce07cbd51368ca2c836.tar.xz discord.py-b86073fac3776cfc64f9bce07cbd51368ca2c836.zip | |
Document behavior of on_disconnect
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst index 0421d5a9..35da0571 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -200,11 +200,11 @@ to handle it, which defaults to print a traceback and ignoring the exception. .. function:: on_disconnect() - Called when the client has disconnected from Discord. This could happen either through - the internet being disconnected, explicit calls to logout, or Discord terminating the connection - one way or the other. + Called when the client has disconnected from Discord, or a connection attempt to Discord has failed. + This could happen either through the internet being disconnected, explicit calls to logout, + or Discord terminating the connection one way or the other. - This function can be called many times. + This function can be called many times without a corresponding :func:`on_connect` call. .. function:: on_shard_disconnect(shard_id) |