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

Fix usage of single backticks to links and code-blocks

Browse Source
This commit is contained in:
Jonah Lawrence
2022-10-26 02:26:56 -06:00
committed by GitHub
parent 44c09c17b4
commit d7b6a2ad12
13 changed files with 40 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
discord/channel.py
View File

@@ -151,7 +151,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
*not* point to an existing or valid message. *not* point to an existing or valid message.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
The number of seconds a member must wait between sending messages The number of seconds a member must wait between sending messages
in this channel. A value of `0` denotes that it is disabled. in this channel. A value of ``0`` denotes that it is disabled.
Bots and users with :attr:`~Permissions.manage_channels` or Bots and users with :attr:`~Permissions.manage_channels` or
:attr:`~Permissions.manage_messages` bypass slowmode. :attr:`~Permissions.manage_messages` bypass slowmode.
nsfw: :class:`bool` nsfw: :class:`bool`
@@ -343,7 +343,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
category. category.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
Specifies the slowmode rate limit for user in this channel, in seconds. Specifies the slowmode rate limit for user in this channel, in seconds.
A value of `0` disables slowmode. The maximum value possible is `21600`. A value of ``0`` disables slowmode. The maximum value possible is ``21600``.
type: :class:`ChannelType` type: :class:`ChannelType`
Change the type of this text channel. Currently, only conversion between Change the type of this text channel. Currently, only conversion between
:attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This :attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This
@@ -739,7 +739,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
Defaults to ``True``. Defaults to ``True``.
slowmode_delay: Optional[:class:`int`] slowmode_delay: Optional[:class:`int`]
Specifies the slowmode rate limit for user in this channel, in seconds. Specifies the slowmode rate limit for user in this channel, in seconds.
The maximum value possible is `21600`. By default no slowmode rate limit The maximum value possible is ``21600``. By default no slowmode rate limit
if this is ``None``. if this is ``None``.
Raises Raises
@@ -2101,7 +2101,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
It may *not* point to an existing or valid thread or message. It may *not* point to an existing or valid thread or message.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
The number of seconds a member must wait between creating threads The number of seconds a member must wait between creating threads
in this forum. A value of `0` denotes that it is disabled. in this forum. A value of ``0`` denotes that it is disabled.
Bots and users with :attr:`~Permissions.manage_channels` or Bots and users with :attr:`~Permissions.manage_channels` or
:attr:`~Permissions.manage_messages` bypass slowmode. :attr:`~Permissions.manage_messages` bypass slowmode.
nsfw: :class:`bool` nsfw: :class:`bool`
@@ -2307,7 +2307,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
category. category.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
Specifies the slowmode rate limit for user in this forum, in seconds. Specifies the slowmode rate limit for user in this forum, in seconds.
A value of `0` disables slowmode. The maximum value possible is `21600`. A value of ``0`` disables slowmode. The maximum value possible is ``21600``.
type: :class:`ChannelType` type: :class:`ChannelType`
Change the type of this text forum. Currently, only conversion between Change the type of this text forum. Currently, only conversion between
:attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This :attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This
@@ -2475,7 +2475,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
If not provided, the channel's default auto archive duration is used. If not provided, the channel's default auto archive duration is used.
slowmode_delay: Optional[:class:`int`] slowmode_delay: Optional[:class:`int`]
Specifies the slowmode rate limit for user in this channel, in seconds. Specifies the slowmode rate limit for user in this channel, in seconds.
The maximum value possible is `21600`. By default no slowmode rate limit The maximum value possible is ``21600``. By default no slowmode rate limit
if this is ``None``. if this is ``None``.
content: Optional[:class:`str`] content: Optional[:class:`str`]
The content of the message to send with the thread. The content of the message to send with the thread.

2
discord/ext/commands/converter.py
View File

@@ -155,7 +155,7 @@ class IDConverter(Converter[T_co]):
class ObjectConverter(IDConverter[discord.Object]): class ObjectConverter(IDConverter[discord.Object]):
"""Converts to a :class:`~discord.Object`. """Converts to a :class:`~discord.Object`.
The argument must follow the valid ID or mention formats (e.g. `<@80088516616269824>`). The argument must follow the valid ID or mention formats (e.g. ``<@80088516616269824>``).
.. versionadded:: 2.0 .. versionadded:: 2.0

2
discord/ext/commands/core.py
View File

@@ -2049,7 +2049,7 @@ def has_role(item: Union[int, str], /) -> Check[Any]:
def has_any_role(*items: Union[int, str]) -> Callable[[T], T]: def has_any_role(*items: Union[int, str]) -> Callable[[T], T]:
r"""A :func:`.check` that is added that checks if the member invoking the r"""A :func:`.check` that is added that checks if the member invoking the
command has **any** of the roles specified. This means that if they have command has **any** of the roles specified. This means that if they have
one out of the three roles specified, then this check will return `True`. one out of the three roles specified, then this check will return ``True``.
Similar to :func:`.has_role`\, the names or IDs passed in must be exact. Similar to :func:`.has_role`\, the names or IDs passed in must be exact.

8
discord/guild.py
View File

@@ -1285,7 +1285,7 @@ class Guild(Hashable):
The new channel's topic. The new channel's topic.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
Specifies the slowmode rate limit for user in this channel, in seconds. Specifies the slowmode rate limit for user in this channel, in seconds.
The maximum value possible is `21600`. The maximum value possible is ``21600``.
nsfw: :class:`bool` nsfw: :class:`bool`
To mark the channel as NSFW or not. To mark the channel as NSFW or not.
news: :class:`bool` news: :class:`bool`
@@ -1598,7 +1598,7 @@ class Guild(Hashable):
To mark the channel as NSFW or not. To mark the channel as NSFW or not.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
Specifies the slowmode rate limit for users in this channel, in seconds. Specifies the slowmode rate limit for users in this channel, in seconds.
The maximum possible value is `21600`. The maximum possible value is ``21600``.
reason: Optional[:class:`str`] reason: Optional[:class:`str`]
The reason for creating this channel. Shows up in the audit log. The reason for creating this channel. Shows up in the audit log.
default_auto_archive_duration: :class:`int` default_auto_archive_duration: :class:`int`
@@ -1729,7 +1729,7 @@ class Guild(Hashable):
The ``rules_channel`` and ``public_updates_channel`` keyword parameters were added. The ``rules_channel`` and ``public_updates_channel`` keyword parameters were added.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
The ``discovery_splash`` and `community` keyword parameters were added. The ``discovery_splash`` and ``community`` keyword parameters were added.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
The newly updated guild is returned. The newly updated guild is returned.
@@ -2856,7 +2856,7 @@ class Guild(Hashable):
Raises Raises
------- -------
TypeError TypeError
`image` was not a :term:`py:bytes-like object`, or ``privacy_level`` ``image`` was not a :term:`py:bytes-like object`, or ``privacy_level``
was not a :class:`PrivacyLevel`, or ``entity_type`` was not an was not a :class:`PrivacyLevel`, or ``entity_type`` was not an
:class:`EntityType`, ``status`` was not an :class:`EventStatus`, :class:`EntityType`, ``status`` was not an :class:`EventStatus`,
or an argument was provided that was incompatible with the provided or an argument was provided that was incompatible with the provided

40
discord/invite.py
View File

@@ -271,25 +271,25 @@ class Invite(Hashable):
The following table illustrates what methods will obtain the attributes: The following table illustrates what methods will obtain the attributes:
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| Attribute | Method | | Attribute | Method |
+====================================+============================================================+ +====================================+==============================================================+
| :attr:`max_age` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` | | :attr:`max_age` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`max_uses` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` | | :attr:`max_uses` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`created_at` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` | | :attr:`created_at` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`temporary` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` | | :attr:`temporary` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`uses` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` | | :attr:`uses` | :meth:`abc.GuildChannel.invites`\, :meth:`Guild.invites` |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`approximate_member_count` | :meth:`Client.fetch_invite` with `with_counts` enabled | | :attr:`approximate_member_count` | :meth:`Client.fetch_invite` with ``with_counts`` enabled |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`approximate_presence_count` | :meth:`Client.fetch_invite` with `with_counts` enabled | | :attr:`approximate_presence_count` | :meth:`Client.fetch_invite` with ``with_counts`` enabled |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
| :attr:`expires_at` | :meth:`Client.fetch_invite` with `with_expiration` enabled | | :attr:`expires_at` | :meth:`Client.fetch_invite` with ``with_expiration`` enabled |
+------------------------------------+------------------------------------------------------------+ +------------------------------------+--------------------------------------------------------------+
If it's not in the table above then it is available by all methods. If it's not in the table above then it is available by all methods.
@@ -323,7 +323,7 @@ class Invite(Hashable):
This includes idle, dnd, online, and invisible members. Offline members are excluded. This includes idle, dnd, online, and invisible members. Offline members are excluded.
expires_at: Optional[:class:`datetime.datetime`] expires_at: Optional[:class:`datetime.datetime`]
The expiration date of the invite. If the value is ``None`` when received through The expiration date of the invite. If the value is ``None`` when received through
`Client.fetch_invite` with `with_expiration` enabled, the invite will never expire. :meth:`Client.fetch_invite` with ``with_expiration`` enabled, the invite will never expire.
.. versionadded:: 2.0 .. versionadded:: 2.0

2
discord/message.py
View File

@@ -1181,7 +1181,7 @@ class PartialMessage(Hashable):
If not provided, the channel's default auto archive duration is used. If not provided, the channel's default auto archive duration is used.
slowmode_delay: Optional[:class:`int`] slowmode_delay: Optional[:class:`int`]
Specifies the slowmode rate limit for user in this channel, in seconds. Specifies the slowmode rate limit for user in this channel, in seconds.
The maximum value possible is `21600`. By default no slowmode rate limit The maximum value possible is ``21600``. By default no slowmode rate limit
if this is ``None``. if this is ``None``.
reason: Optional[:class:`str`] reason: Optional[:class:`str`]
The reason for creating a new thread. Shows up on the audit log. The reason for creating a new thread. Shows up on the audit log.

2
discord/raw_models.py
View File

@@ -193,7 +193,7 @@ class RawReactionActionEvent(_RawReprMixin):
emoji: :class:`PartialEmoji` emoji: :class:`PartialEmoji`
The custom or unicode emoji being used. The custom or unicode emoji being used.
member: Optional[:class:`Member`] member: Optional[:class:`Member`]
The member who added the reaction. Only available if `event_type` is `REACTION_ADD` and the reaction is inside a guild. The member who added the reaction. Only available if ``event_type`` is ``REACTION_ADD`` and the reaction is inside a guild.
.. versionadded:: 1.3 .. versionadded:: 1.3

2
discord/scheduled_event.py
View File

@@ -362,7 +362,7 @@ class ScheduledEvent(Hashable):
Raises Raises
------- -------
TypeError TypeError
`image` was not a :term:`py:bytes-like object`, or ``privacy_level`` ``image`` was not a :term:`py:bytes-like object`, or ``privacy_level``
was not a :class:`PrivacyLevel`, or ``entity_type`` was not an was not a :class:`PrivacyLevel`, or ``entity_type`` was not an
:class:`EntityType`, ``status`` was not an :class:`EventStatus`, or :class:`EntityType`, ``status`` was not an :class:`EventStatus`, or
an argument was provided that was incompatible with the scheduled event's an argument was provided that was incompatible with the scheduled event's

2
discord/threads.py
View File

@@ -102,7 +102,7 @@ class Thread(Messageable, Hashable):
*not* point to an existing or valid message. *not* point to an existing or valid message.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
The number of seconds a member must wait between sending messages The number of seconds a member must wait between sending messages
in this thread. A value of `0` denotes that it is disabled. in this thread. A value of ``0`` denotes that it is disabled.
Bots and users with :attr:`~Permissions.manage_channels` or Bots and users with :attr:`~Permissions.manage_channels` or
:attr:`~Permissions.manage_messages` bypass slowmode. :attr:`~Permissions.manage_messages` bypass slowmode.
message_count: :class:`int` message_count: :class:`int`

2
discord/widget.py
View File

@@ -121,7 +121,7 @@ class WidgetMember(BaseUser):
.. describe:: str(x) .. describe:: str(x)
Returns the widget member's `name#discriminator`. Returns the widget member's ``name#discriminator``.
Attributes Attributes
----------- -----------

2
docs/migrating.rst
View File

@@ -1267,7 +1267,7 @@ The following changes have been made:
- :meth:`Permissions.stage_moderator` now includes the :attr:`Permissions.manage_channels` permission and the :attr:`Permissions.request_to_speak` permission is no longer included. - :meth:`Permissions.stage_moderator` now includes the :attr:`Permissions.manage_channels` permission and the :attr:`Permissions.request_to_speak` permission is no longer included.
- :attr:`File.filename` will no longer be ``None``, in situations where previously this was the case the filename is set to `'untitled'`. - :attr:`File.filename` will no longer be ``None``, in situations where previously this was the case the filename is set to ``'untitled'``.
- :attr:`Message.application` will no longer be a raw :class:`dict` of the API payload and now returns an instance of :class:`MessageApplication`. - :attr:`Message.application` will no longer be a raw :class:`dict` of the API payload and now returns an instance of :class:`MessageApplication`.

2
docs/quickstart.rst
View File

@@ -47,7 +47,7 @@ with the library.
There's a lot going on here, so let's walk you through it step by step. There's a lot going on here, so let's walk you through it step by step.
1. The first line just imports the library, if this raises a `ModuleNotFoundError` or `ImportError` 1. The first line just imports the library, if this raises a :exc:`ModuleNotFoundError` or :exc:`ImportError`
then head on over to :ref:`installing` section to properly install. then head on over to :ref:`installing` section to properly install.
2. Next, we create an instance of a :class:`Client`. This client is our connection to Discord. 2. Next, we create an instance of a :class:`Client`. This client is our connection to Discord.
3. We then use the :meth:`Client.event` decorator to register an event. This library has many events. 3. We then use the :meth:`Client.event` decorator to register an event. This library has many events.

2
docs/whats_new.rst
View File

@@ -975,7 +975,7 @@ v0.14.1
Bug fixes Bug fixes
~~~~~~~~~~ ~~~~~~~~~~
- Fix bug with `Reaction` not being visible at import. - Fix bug with ``Reaction`` not being visible at import.
- This was also breaking the documentation. - This was also breaking the documentation.
.. _v0p14p0: .. _v0p14p0: