Browse Source
[docs] fix gateway payload hyperlinks
pull/9794/head
Sebastian Law
12 months ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with
5 additions and
5 deletions
-
discord/raw_models.py
-
discord/voice_client.py
-
docs/api.rst
|
|
@ -158,7 +158,7 @@ class RawMessageUpdateEvent(_RawReprMixin): |
|
|
|
.. versionadded:: 1.7 |
|
|
|
|
|
|
|
data: :class:`dict` |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway#message-update>` |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway-events#message-update>` |
|
|
|
cached_message: Optional[:class:`Message`] |
|
|
|
The cached message, if found in the internal message cache. Represents the message before |
|
|
|
it is modified by the data in :attr:`RawMessageUpdateEvent.data`. |
|
|
@ -355,7 +355,7 @@ class RawThreadUpdateEvent(_RawReprMixin): |
|
|
|
parent_id: :class:`int` |
|
|
|
The ID of the channel the thread belongs to. |
|
|
|
data: :class:`dict` |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway#thread-update>` |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway-events#thread-update>` |
|
|
|
thread: Optional[:class:`discord.Thread`] |
|
|
|
The thread, if it could be found in the internal cache. |
|
|
|
""" |
|
|
@ -414,7 +414,7 @@ class RawThreadMembersUpdate(_RawReprMixin): |
|
|
|
member_count: :class:`int` |
|
|
|
The approximate number of members in the thread. This caps at 50. |
|
|
|
data: :class:`dict` |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway#thread-members-update>`. |
|
|
|
The raw data given by the :ddocs:`gateway <topics/gateway-events#thread-members-update>`. |
|
|
|
""" |
|
|
|
|
|
|
|
__slots__ = ('thread_id', 'guild_id', 'member_count', 'data') |
|
|
|
|
|
@ -125,7 +125,7 @@ class VoiceProtocol: |
|
|
|
Parameters |
|
|
|
------------ |
|
|
|
data: :class:`dict` |
|
|
|
The raw :ddocs:`voice server update payload <topics/gateway#voice-server-update>`. |
|
|
|
The raw :ddocs:`voice server update payload <topics/gateway-events#voice-server-update>`. |
|
|
|
""" |
|
|
|
raise NotImplementedError |
|
|
|
|
|
|
|
|
|
@ -1008,7 +1008,7 @@ Messages |
|
|
|
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 :ddocs:`gateway <topics/gateway#message-update>`. |
|
|
|
the raw data given by the :ddocs:`gateway <topics/gateway-events#message-update>`. |
|
|
|
|
|
|
|
Since the data payload can be partial, care must be taken when accessing stuff in the dictionary. |
|
|
|
One example of a common case of partial data is when the ``'content'`` key is inaccessible. This |
|
|
|