From d8f81588921c3f687d17d5d7e823537487e3c1a7 Mon Sep 17 00:00:00 2001 From: dolfies Date: Tue, 28 Mar 2023 22:12:41 -0400 Subject: [PATCH] Document PRESENCE_UPDATE changes --- docs/api.rst | 10 +++++----- docs/migrating.rst | 2 ++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 435924215..64ad96011 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -962,7 +962,7 @@ Members .. function:: on_presence_update(before, after) - Called when a :class:`Member` updates their presence. + Called when a :class:`Member` or :class:`Relationship` updates their presence. This is called when one or more of the following things change: @@ -971,10 +971,10 @@ Members .. versionadded:: 2.0 - :param before: The updated member's old info. - :type before: :class:`Member` - :param after: The updated member's updated info. - :type after: :class:`Member` + :param before: The updated member or friend's old info. + :type before: Union[:class:`Member`, :class:`Relationship`] + :param after: The updated member or friend's updated info. + :type after: Union[:class:`Member`, :class:`Relationship`] .. function:: on_raw_member_list_update(data) diff --git a/docs/migrating.rst b/docs/migrating.rst index ec34f0fed..36421a5ef 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -615,6 +615,8 @@ From API perspective, these are separate events and as such, this change improve Presence updates usually are 90% of all handled events so splitting these should benefit listeners that were only interested in member updates. +Note that this event is also called when a :class:`Relationship` presence is updated. + Quick example: .. code:: python