aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst
index f1e0ec5b..935f05dc 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -184,11 +184,19 @@ to handle it, which defaults to print a traceback and ignore the exception.
:param member: The :class:`Member` that joined or left.
-.. function:: on_member_update(member)
+.. function:: on_member_update(before, after)
Called when a :class:`Member` updates their profile.
- :param member: The :class:`Member` that updated their profile with the updated info.
+ This is called when one or more of the following things change:
+
+ - status
+ - game playing
+ - avatar
+ - nickname
+
+ :param before: The :class:`Member` that updated their profile with the old info.
+ :param after: The :class:`Member` that updated their profile with the updated info.
.. function:: on_server_join(server)