Browse Source

[docs] fix gateway payload hyperlinks

pull/10109/head
Sebastian Law 1 year ago
committed by dolfies
parent
commit
aff31f9575
  1. 4
      discord/raw_models.py
  2. 2
      discord/voice_client.py
  3. 2
      docs/api.rst

4
discord/raw_models.py

@ -155,7 +155,7 @@ class RawMessageUpdateEvent(_RawReprMixin):
.. versionadded:: 1.7 .. versionadded:: 1.7
data: :class:`dict` 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`] cached_message: Optional[:class:`Message`]
The cached message, if found in the internal message cache. Represents the message before The cached message, if found in the internal message cache. Represents the message before
it is modified by the data in :attr:`RawMessageUpdateEvent.data`. it is modified by the data in :attr:`RawMessageUpdateEvent.data`.
@ -379,7 +379,7 @@ class RawThreadMembersUpdate(_RawReprMixin):
member_count: :class:`int` member_count: :class:`int`
The approximate number of members in the thread. This caps at 50. The approximate number of members in the thread. This caps at 50.
data: :class:`dict` 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') __slots__ = ('thread_id', 'guild_id', 'member_count', 'data')

2
discord/voice_client.py

@ -124,7 +124,7 @@ class VoiceProtocol:
Parameters Parameters
------------ ------------
data: :class:`dict` 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 raise NotImplementedError

2
docs/api.rst

@ -1197,7 +1197,7 @@ Messages
will return a :class:`Message` object that represents the message before the content was modified. 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 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. 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 One example of a common case of partial data is when the ``'content'`` key is inaccessible. This

Loading…
Cancel
Save