diff options
| author | ChristopherJHart <[email protected]> | 2021-01-18 04:55:59 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-01-18 04:55:59 -0500 |
| commit | 050bf74f5db0046c0010c2b7c3ac0c5fd0a500f9 (patch) | |
| tree | c6c4cc13c3cccb2f8ee24c3fd05d192d617cf27f /docs | |
| parent | Add MessageReference.jump_url (diff) | |
| download | discord.py-050bf74f5db0046c0010c2b7c3ac0c5fd0a500f9.tar.xz discord.py-050bf74f5db0046c0010c2b7c3ac0c5fd0a500f9.zip | |
Clarify on_raw_message_edit cached message nature
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 5 |
1 files changed, 4 insertions, 1 deletions
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 <https://discord.com/developers/docs/topics/gateway#message-update>`_. |