aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst
index f9853b6d..cc298903 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -17,7 +17,7 @@ The following section outlines the API of discord.py.
Client
-------
-.. autoclass:: Client
+.. autoclass:: discord.async_client.Client
:members:
.. _discord-api-events:
@@ -59,6 +59,11 @@ to handle it, which defaults to print a traceback and ignore the exception.
def on_ready():
pass
+ Since this can be a potentially common mistake, there is a helper
+ decorator, :meth:`Client.async_event` to convert a basic function
+ into a coroutine and an event at the same time. Note that it is
+ not necessary if you use ``async def``.
+
.. versionadded:: 0.7.0
Subclassing to listen to events.