Document behavior of on_disconnect

This commit is contained in:
Sebastian Law 2021-02-20 17:47:29 -08:00 committed by GitHub
parent 27c7fb6aed
commit b86073fac3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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)