mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-09 19:24:15 +00:00
Code Issues Projects Releases Wiki Activity

Fix various reference issues in documentation

Browse Source 
Co-Authored-By: Riley Shaw <30989490+ShineyDev@users.noreply.github.com>
This commit is contained in:
Josh
2021-05-06 21:51:07 +10:00
committed by GitHub
parent 1bf7aadf94
commit 3864fb37a0
24 changed files with 106 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/api.rst
View File

@ -367,7 +367,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute
If this occurs increase the :class:`max_messages <Client>` parameter
or use the :func:`on_raw_message_delete` event instead.
This requires :attr:`Intents.messages` to be enabled.
@ -384,7 +384,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
the messages list. Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute
If this occurs increase the :class:`max_messages <Client>` parameter
or use the :func:`on_raw_bulk_message_delete` event instead.
This requires :attr:`Intents.messages` to be enabled.
@ -425,7 +425,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute
If this occurs increase the :class:`max_messages <Client>` parameter
or use the :func:`on_raw_message_edit` event instead.
The following non-exhaustive cases trigger this event:
@ -1078,6 +1078,59 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
.. class:: UserFlags
Represents Discord User flags.
.. attribute:: staff
The user is a Discord Employee.
.. attribute:: partner
The user is a Discord Partner.
.. attribute:: hypesquad
The user is a HypeSquad Events member.
.. attribute:: bug_hunter
The user is a Bug Hunter.
.. attribute:: mfa_sms
The user has SMS recovery for Multi Factor Authentication enabled.
.. attribute:: premium_promo_dismissed
The user has dismissed the Discord Nitro promotion.
.. attribute:: hypesquad_bravery
The user is a HypeSquad Bravery member.
.. attribute:: hypesquad_brilliance
The user is a HypeSquad Brilliance member.
.. attribute:: hypesquad_balance
The user is a HypeSquad Balance member.
.. attribute:: early_supporter
The user is an Early Supporter.
.. attribute:: team_user
The user is a Team User.
.. attribute:: system
The user is a system user (i.e. represents Discord officially).
.. attribute:: has_unread_urgent_messages
The user has an unready system message.
.. attribute:: bug_hunter_level_2
The user is a Bug Hunter Level 2.
.. attribute:: verified_bot
The user is a Verified Bot.
.. attribute:: verified_bot_developer
The user is an Early Verified Bot Developer.
.. class:: ActivityType
Specifies the type of :class:`Activity`. This is used to check how to
@ -1854,7 +1907,7 @@ of :class:`enum.Enum`.
.. class:: TeamMembershipState
Represents the membership state of a team member retrieved through :func:`Bot.application_info`.
Represents the membership state of a team member retrieved through :func:`Client.application_info`.
.. versionadded:: 1.3
@ -2581,6 +2634,7 @@ Webhook
.. autoclass:: Webhook()
:members:
:inherited-members:
WebhookMessage
~~~~~~~~~~~~~~~~
@ -2597,6 +2651,7 @@ SyncWebhook
.. autoclass:: SyncWebhook()
:members:
:inherited-members:
SyncWebhookMessage
~~~~~~~~~~~~~~~~~~~