aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-06-10 20:16:21 -0400
committerRapptz <[email protected]>2016-06-10 20:16:21 -0400
commitd914c0a4e463d6d7dd3206a9a3596f8f7a022a89 (patch)
tree5481b86e487b05a37734f24617e1a63adb4691ce /docs/api.rst
parent[commands] Fix issue with proper local error handlers not beign called. (diff)
downloaddiscord.py-d914c0a4e463d6d7dd3206a9a3596f8f7a022a89.tar.xz
discord.py-d914c0a4e463d6d7dd3206a9a3596f8f7a022a89.zip
Clarify `on_ready` triggering more than twice.
On that note, fix the background_task example to use `Client.run` instead of manual loop management. That way the task will be cleaned up and cancelled inside `Client.run`.
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index c50098d9..4700a3ba 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -108,6 +108,9 @@ to handle it, which defaults to print a traceback and ignore the exception.
.. warning::
This function is not guaranteed to be the first event called.
+ Likewise, this function is **not** guaranteed to only be called
+ once. This library implements reconnection logic and thus will
+ end up calling this event whenever a RESUME request fails.
.. function:: on_resumed()