From 050bf74f5db0046c0010c2b7c3ac0c5fd0a500f9 Mon Sep 17 00:00:00 2001 From: ChristopherJHart Date: Mon, 18 Jan 2021 04:55:59 -0500 Subject: Clarify on_raw_message_edit cached message nature --- docs/api.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/api.rst') diff --git a/docs/api.rst b/docs/api.rst index b88ccd5d..9990d036 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -448,7 +448,10 @@ to handle it, which defaults to print a traceback and ignoring the exception. regardless of the state of the internal message cache. If the message is found in the message cache, - it can be accessed via :attr:`RawMessageUpdateEvent.cached_message` + it can be accessed via :attr:`RawMessageUpdateEvent.cached_message`. The cached message represents + the message before it has been edited. For example, if the content of a message is modified and + triggers the :func:`on_raw_message_edit` coroutine, the :attr:`RawMessageUpdateEvent.cached_message` + will return a :class:`Message` object that represents the message before the content was modified. Due to the inherently raw nature of this event, the data parameter coincides with the raw data given by the `gateway `_. -- cgit v1.2.3