mirror
/
Rapptz.discord.py
mirror of https://github.com/Rapptz/discord.py
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

[docs] fix gateway payload hyperlinks

pull/9794/head
Sebastian Law 12 months ago
committed by GitHub
parent
5497674ae2
commit
0362b2fd4e
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      discord/raw_models.py
  2. 2
      discord/voice_client.py
  3. 2
      docs/api.rst

6
discord/raw_models.py
View File

@ -158,7 +158,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`.
@ -355,7 +355,7 @@ class RawThreadUpdateEvent(_RawReprMixin):
parent_id: :class:`int` parent_id: :class:`int`
The ID of the channel the thread belongs to. The ID of the channel the thread belongs to.
data: :class:`dict` 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`] thread: Optional[:class:`discord.Thread`]
The thread, if it could be found in the internal cache. The thread, if it could be found in the internal cache.
""" """
@ -414,7 +414,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
View File

@ -125,7 +125,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
View File

@ -1008,7 +1008,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

Write Preview
Loading…
Cancel
Save