aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index de55e6f5..0579cb79 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -103,6 +103,14 @@ to handle it, which defaults to print a traceback and ignoring the exception.
The warnings on :func:`on_ready` also apply.
+.. function:: on_disconnect()
+
+ Called when the client has disconnected from Discord. This could happen either through
+ the internet being disconnect, explicit calls to logout, or Discord terminating the connection
+ one way or the other.
+
+ This function can be called many times.
+
.. function:: on_ready()
Called when the client is done preparing the data received from Discord. Usually after login is successful