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

Fix usage of single backticks to links and code-blocks

pull/10109/head
Jonah Lawrence 3 years ago
committed by dolfies
parent
abe9e6d123
commit
9a975acd26
12 changed files with 37 additions and 41 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 12
      discord/channel.py
  2. 2
      discord/ext/commands/converter.py
  3. 2
      discord/ext/commands/core.py
  4. 8
      discord/guild.py
  5. 40
      discord/invite.py
  6. 2
      discord/message.py
  7. 2
      discord/raw_models.py
  8. 2
      discord/scheduled_event.py
  9. 2
      discord/threads.py
  10. 2
      discord/widget.py
  11. 2
      docs/migrating.rst
  12. 2
      docs/quickstart.rst

12
discord/channel.py
View File

@ -153,7 +153,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
*not* point to an existing or valid message.
slowmode_delay: :class:`int`
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
:attr:`~Permissions.manage_messages` bypass slowmode.
nsfw: :class:`bool`
@ -338,7 +338,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
category.
slowmode_delay: :class:`int`
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`
Change the type of this text channel. Currently, only conversion between
:attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This
@ -711,7 +711,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
Defaults to ``True``.
slowmode_delay: Optional[:class:`int`]
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``.
Raises
@ -2037,7 +2037,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
It may *not* point to an existing or valid thread or message.
slowmode_delay: :class:`int`
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
:attr:`~Permissions.manage_messages` bypass slowmode.
nsfw: :class:`bool`
@ -2239,7 +2239,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
category.
slowmode_delay: :class:`int`
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`
Change the type of this text forum. Currently, only conversion between
:attr:`ChannelType.text` and :attr:`ChannelType.news` is supported. This
@ -2404,7 +2404,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
If not provided, the channel's default auto archive duration is used.
slowmode_delay: Optional[:class:`int`]
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``.
content: Optional[:class:`str`]
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]):
"""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

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

@ -2039,7 +2039,7 @@ def has_role(item: Union[int, str], /) -> Check[Any]:
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
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.

8
discord/guild.py
View File

@ -1326,7 +1326,7 @@ class Guild(Hashable):
The new channel's topic.
slowmode_delay: :class:`int`
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`
To mark the channel as NSFW or not.
news: :class:`bool`
@ -1639,7 +1639,7 @@ class Guild(Hashable):
To mark the channel as NSFW or not.
slowmode_delay: :class:`int`
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`]
The reason for creating this channel. Shows up in the audit log.
default_auto_archive_duration: :class:`int`
@ -1772,7 +1772,7 @@ class Guild(Hashable):
The ``rules_channel`` and ``public_updates_channel`` keyword parameters were added.
.. versionchanged:: 2.0
The ``discovery_splash`` and `community` keyword parameters were added.
The ``discovery_splash`` and ``community`` keyword parameters were added.
.. versionchanged:: 2.0
The newly updated guild is returned.
@ -2864,7 +2864,7 @@ class Guild(Hashable):
Raises
-------
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
:class:`EntityType`, ``status`` was not an :class:`EventStatus`,
or an argument was provided that was incompatible with the provided

40
discord/invite.py
View File

@ -309,23 +309,23 @@ class Invite(Hashable):
The following table illustrates what methods will obtain the attributes:
+------------------------------------+------------------------------------------------------------+
| Attribute | Method |
+====================================+============================================================+
| :attr:`max_age` | :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:`temporary` | :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_presence_count` | :meth:`Client.fetch_invite` with `with_counts` enabled |
+------------------------------------+------------------------------------------------------------+
+------------------------------------+--------------------------------------------------------------+
| Attribute | Method |
+====================================+==============================================================+
| :attr:`max_age` | :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:`temporary` | :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_presence_count` | :meth:`Client.fetch_invite` with ``with_counts`` enabled |
+------------------------------------+--------------------------------------------------------------+
If it's not in the table above then it is available by all methods.
@ -340,7 +340,6 @@ class Invite(Hashable):
The type of invite.
.. versionadded:: 2.0
guild: Optional[Union[:class:`Guild`, :class:`Object`, :class:`PartialInviteGuild`]]
The guild the invite is for. Can be ``None`` if not a guild invite.
revoked: Optional[:class:`bool`]
@ -364,22 +363,19 @@ class Invite(Hashable):
This includes idle, dnd, online, and invisible members. Offline members are excluded.
expires_at: Optional[:class:`datetime.datetime`]
The expiration date of the invite. If the value is ``None`` (unless received through
`Client.fetch_invite` with `with_expiration` disabled), the invite will never expire.
:meth:`Client.fetch_invite` with ``with_expiration`` disabled), the invite will never expire.
.. versionadded:: 2.0
channel: Optional[Union[:class:`abc.GuildChannel`, :class:`GroupChannel`, :class:`Object`, :class:`PartialInviteChannel`]]
The channel the invite is for. Can be ``None`` if not a guild invite.
target_type: :class:`InviteTarget`
The type of target for the voice channel invite.
.. versionadded:: 2.0
target_user: Optional[:class:`User`]
The user whose stream to display for this invite, if any.
.. versionadded:: 2.0
target_application: Optional[:class:`PartialApplication`]
The embedded application the invite targets, if any.

2
discord/message.py
View File

@ -1038,7 +1038,7 @@ class PartialMessage(Hashable):
If not provided, the channel's default auto archive duration is used.
slowmode_delay: Optional[:class:`int`]
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``.
reason: Optional[:class:`str`]
The reason for creating a new thread. Shows up on the audit log.

2
discord/raw_models.py
View File

@ -179,7 +179,7 @@ class RawReactionActionEvent(_RawReprMixin):
emoji: :class:`PartialEmoji`
The custom or unicode emoji being used.
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

2
discord/scheduled_event.py
View File

@ -358,7 +358,7 @@ class ScheduledEvent(Hashable):
Raises
-------
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
:class:`EntityType`, ``status`` was not an :class:`EventStatus`, or
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.
slowmode_delay: :class:`int`
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
:attr:`~Permissions.manage_messages` bypass slowmode.
message_count: :class:`int`

2
discord/widget.py
View File

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

2
docs/migrating.rst
View File

@ -1145,7 +1145,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.
- :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'``.
:meth:`VoiceProtocol.connect` signature changes.
--------------------------------------------------

2
docs/quickstart.rst
View File

@ -42,7 +42,7 @@ with the library.
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.
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.

Write Preview
Loading…
Cancel
Save