Browse Source

Document behavior of on_disconnect

pull/6451/head
Sebastian Law 4 years ago
committed by GitHub
parent
commit
b86073fac3
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/api.rst

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

Loading…
Cancel
Save