mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-07 18:33:02 +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

14
discord/abc.py
View File

@ -114,7 +114,7 @@ class User(Snowflake, Protocol):
The user's username.
discriminator: :class:`str`
The user's discriminator.
avatar: :class:`Asset`
avatar: :class:`~discord.Asset`
The avatar asset the user has.
bot: :class:`bool`
If the user is a bot account.
@ -634,7 +634,7 @@ class GuildChannel:
Deletes the channel.
You must have :attr:`~Permissions.manage_channels` permission to use this.
You must have :attr:`~discord.Permissions.manage_channels` permission to use this.
Parameters
-----------
@ -678,7 +678,7 @@ class GuildChannel:
If the ``overwrite`` parameter is ``None``, then the permission
overwrites are deleted.
You must have the :attr:`~Permissions.manage_roles` permission to use this.
You must have the :attr:`~discord.Permissions.manage_roles` permission to use this.
Examples
----------
@ -860,7 +860,7 @@ class GuildChannel:
A rich interface to help move a channel relative to other channels.
If exact position movement is required, :meth:`edit` should be used instead.
If exact position movement is required, ``edit`` should be used instead.
You must have the :attr:`~discord.Permissions.manage_channels` permission to
do this.
@ -990,7 +990,7 @@ class GuildChannel:
Creates an instant invite from a text or voice channel.
You must have the :attr:`~Permissions.create_instant_invite` permission to
You must have the :attr:`~discord.Permissions.create_instant_invite` permission to
do this.
Parameters
@ -1040,7 +1040,7 @@ class GuildChannel:
Returns a list of all active instant invites from this channel.
You must have :attr:`~Permissions.manage_channels` to get this information.
You must have :attr:`~discord.Permissions.manage_channels` to get this information.
Raises
-------
@ -1321,7 +1321,7 @@ class Messageable(Protocol):
def history(self, *, limit=100, before=None, after=None, around=None, oldest_first=None):
"""Returns an :class:`~discord.AsyncIterator` that enables receiving the destination's message history.
You must have :attr:`~Permissions.read_message_history` permissions to use this.
You must have :attr:`~discord.Permissions.read_message_history` permissions to use this.
Examples
---------

6
discord/client.py
View File

@ -287,13 +287,13 @@ class Client:
If this is not passed via ``__init__`` then this is retrieved
through the gateway when an event contains the data. Usually
after :func:`on_connect` is called.
after :func:`~discord.on_connect` is called.
"""
return self._connection.application_id
@property
def application_flags(self) -> ApplicationFlags:
""":class:`ApplicationFlags`: The client's application flags.
""":class:`~discord.ApplicationFlags`: The client's application flags.
.. versionadded: 2.0
"""
@ -1261,7 +1261,7 @@ class Client:
.. note::
This method is an API call. If you have :attr:`Intents.members` and member cache enabled, consider :meth:`get_user` instead.
This method is an API call. If you have :attr:`discord.Intents.members` and member cache enabled, consider :meth:`get_user` instead.
Parameters
-----------

4
discord/ext/commands/bot.py
View File

@ -220,7 +220,7 @@ class BotBase(GroupMixin):
The function that was used as a global check.
call_once: :class:`bool`
If the function should only be called once per
:meth:`.Command.invoke` call.
:meth:`.invoke` call.
"""
if call_once:
@ -253,7 +253,7 @@ class BotBase(GroupMixin):
r"""A decorator that adds a "call once" global check to the bot.
Unlike regular global checks, this one is called only once
per :meth:`.Command.invoke` call.
per :meth:`.invoke` call.
Regular global checks are called whenever a command is called
or :meth:`.Command.can_run` is called. This type of check

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

@ -334,7 +334,7 @@ class Cog(metaclass=CogMeta):
@_cog_special_method
def cog_check(self, ctx):
"""A special method that registers as a :func:`commands.check`
"""A special method that registers as a :func:`~discord.ext.commands.check`
for every command and subcommand in this cog.
This function **can** be a coroutine and must take a sole parameter,

4
discord/ext/commands/context.py
View File

@ -47,12 +47,12 @@ class Context(discord.abc.Messageable):
The bot that contains the command being executed.
args: :class:`list`
The list of transformed arguments that were passed into the command.
If this is accessed during the :func:`on_command_error` event
If this is accessed during the :func:`.on_command_error` event
then this list could be incomplete.
kwargs: :class:`dict`
A dictionary of transformed arguments that were passed into the command.
Similar to :attr:`args`\, if this is accessed in the
:func:`on_command_error` event then this dict could be incomplete.
:func:`.on_command_error` event then this dict could be incomplete.
current_parameter: Optional[:class:`inspect.Parameter`]
The parameter that is currently being inspected and converted.
This is only of use for within converters.

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

@ -516,7 +516,7 @@ class ColourConverter(Converter[discord.Colour]):
- ``#<hex>``
- ``0x#<hex>``
- ``rgb(<number>, <number>, <number>)``
- Any of the ``classmethod`` in :class:`Colour`
- Any of the ``classmethod`` in :class:`~discord.Colour`
- The ``_`` in the name can be optionally replaced with spaces.

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

@ -908,9 +908,9 @@ class Command(_BaseCommand):
def short_doc(self):
""":class:`str`: Gets the "short" documentation of a command.
By default, this is the :attr:`brief` attribute.
By default, this is the :attr:`.brief` attribute.
If that lookup leads to an empty string then the first line of the
:attr:`help` attribute is used instead.
:attr:`.help` attribute is used instead.
"""
if self.brief is not None:
return self.brief
@ -979,7 +979,7 @@ class Command(_BaseCommand):
"""|coro|
Checks if the command can be executed by checking all the predicates
inside the :attr:`checks` attribute. This also checks whether the
inside the :attr:`~Command.checks` attribute. This also checks whether the
command is disabled.
.. versionchanged:: 1.3

8
discord/ext/commands/errors.py
View File

@ -89,7 +89,7 @@ class CommandError(DiscordException):
This exception and exceptions inherited from it are handled
in a special way as they are caught and passed into a special event
from :class:`.Bot`\, :func:`on_command_error`.
from :class:`.Bot`\, :func:`.on_command_error`.
"""
def __init__(self, message=None, *args):
if message is not None:
@ -457,7 +457,7 @@ class CommandOnCooldown(CommandError):
Attributes
-----------
cooldown: Cooldown
cooldown: ``Cooldown``
A class with attributes ``rate``, ``per``, and ``type`` similar to
the :func:`.cooldown` decorator.
retry_after: :class:`float`
@ -654,7 +654,7 @@ class BadUnionArgument(UserInputError):
-----------
param: :class:`inspect.Parameter`
The parameter that failed being converted.
converters: Tuple[Type, ...]
converters: Tuple[Type, ``...``]
A tuple of converters attempted in conversion, in order of failure.
errors: List[:class:`CommandError`]
A list of errors that were caught from failing the conversion.
@ -692,7 +692,7 @@ class BadLiteralArgument(UserInputError):
-----------
param: :class:`inspect.Parameter`
The parameter that failed being converted.
literals: Tuple[Any, ...]
literals: Tuple[Any, ``...``]
A tuple of values compared against in conversion, in order of failure.
errors: List[:class:`CommandError`]
A list of errors that were caught from failing the conversion.

11
discord/ext/commands/help.py
View File

@ -277,9 +277,9 @@ class HelpCommand:
Defaults to ``False``.
verify_checks: Optional[:class:`bool`]
Specifies if commands should have their :attr:`.Command.checks` called
and verified. If ``True``, always calls :attr:`.Commands.checks`.
If ``None``, only calls :attr:`.Commands.checks` in a guild setting.
If ``False``, never calls :attr:`.Commands.checks`. Defaults to ``True``.
and verified. If ``True``, always calls :attr:`.Command.checks`.
If ``None``, only calls :attr:`.Command.checks` in a guild setting.
If ``False``, never calls :attr:`.Command.checks`. Defaults to ``True``.
.. versionchanged:: 1.7
command_attrs: :class:`dict`
@ -615,8 +615,7 @@ class HelpCommand:
"""|coro|
Handles the implementation when an error happens in the help command.
For example, the result of :meth:`command_not_found` or
:meth:`command_has_no_subcommand_found` will be passed here.
For example, the result of :meth:`command_not_found` will be passed here.
You can override this method to customise the behaviour.
@ -949,7 +948,7 @@ class DefaultHelpCommand(HelpCommand):
if the list of commands is greater than 0.
max_size: Optional[:class:`int`]
The max size to use for the gap between indents.
If unspecified, calls :meth:`get_max_size` on the
If unspecified, calls :meth:`~HelpCommand.get_max_size` on the
commands parameter.
"""

4
discord/guild.py
View File

@ -143,7 +143,7 @@ class Guild(Hashable):
- ``COMMERCE``: Guild can sell things using store channels.
- ``PUBLIC``: Guild is a public guild.
- ``NEWS``: Guild can create news channels.
- ``BANNER``: Guild can upload and use a banner (i.e. :meth:`banner_url`).
- ``BANNER``: Guild can upload and use a banner. (i.e. :attr:`.banner`)
- ``ANIMATED_ICON``: Guild can upload an animated icon.
- ``PUBLIC_DISABLED``: Guild cannot be public.
- ``WELCOME_SCREEN_ENABLED``: Guild has enabled the welcome screen
@ -1042,7 +1042,7 @@ class Guild(Hashable):
The new name of the guild.
description: Optional[:class:`str`]
The new description of the guild. Could be ``None`` for no description.
This is only available to guilds that contain ``PUBLIC`` in :attr:`Guild.features`.
This is only available to guilds that contain ``PUBLIC`` in :attr:`Guild.features`.
icon: :class:`bytes`
A :term:`py:bytes-like object` representing the icon. Only PNG/JPEG is supported.
GIF is only available to guilds that contain ``ANIMATED_ICON`` in :attr:`Guild.features`.

2
discord/invite.py
View File

@ -281,7 +281,7 @@ class Invite(Hashable):
The target of this invite in the case of stream invites.
.. versionadded:: 2.0
target_type: :class:`InviteType`
target_type: :class:`InviteTarget`
The invite's target type.
.. versionadded:: 2.0

2
discord/player.py
View File

@ -73,7 +73,7 @@ class AudioSource:
If the audio is complete, then returning an empty
:term:`py:bytes-like object` to signal this is the way to do so.
If :meth:`is_opus` method returns ``True``, then it must return
If :meth:`~AudioSource.is_opus` method returns ``True``, then it must return
20ms worth of Opus encoded audio. Otherwise, it must be 20ms
worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes
per frame (20ms worth of audio).

4
discord/utils.py
View File

@ -353,7 +353,7 @@ def find(predicate: Callable[[T], Any], seq: Iterable[T]) -> Optional[T]:
-----------
predicate
A function that returns a boolean-like result.
seq: iterable
seq: :class:`collections.abc.Iterable`
The iterable to search through.
"""
@ -530,7 +530,7 @@ async def sleep_until(when: datetime.datetime, result: Optional[T] = None) -> Op
def utcnow() -> datetime.datetime:
"""A helper function to return an aware UTC datetime representing the current time.
This should be preferred to :func:`datetime.datetime.utcnow` since it is an aware
This should be preferred to :meth:`datetime.datetime.utcnow` since it is an aware
datetime, compared to the naive datetime in the standard library.
.. versionadded:: 2.0

2
discord/voice_client.py
View File

@ -71,7 +71,7 @@ class VoiceProtocol:
This class allows you to implement a protocol to allow for an external
method of sending voice, such as Lavalink_ or a native library implementation.
These classes are passed to :meth:`abc.Connectable.connect`.
These classes are passed to :meth:`abc.Connectable.connect <VoiceChannel.connect>`.
.. _Lavalink: https://github.com/freyacodes/Lavalink

2
discord/webhook/async_.py
View File

@ -788,8 +788,6 @@ class Webhook(BaseWebhook):
received without authentication then this will be ``None``.
name: Optional[:class:`str`]
The default name of the webhook.
avatar: Optional[:class:`str`]
The default avatar of the webhook.
source_guild: Optional[:class:`PartialWebhookGuild`]
The guild of the channel that this webhook is following.
Only given if :attr:`type` is :attr:`WebhookType.channel_follower`.

2
discord/webhook/sync.py
View File

@ -478,8 +478,6 @@ class SyncWebhook(BaseWebhook):
received without authentication then this will be ``None``.
name: Optional[:class:`str`]
The default name of the webhook.
avatar: Optional[:class:`str`]
The default avatar of the webhook.
source_guild: Optional[:class:`PartialWebhookGuild`]
The guild of the channel that this webhook is following.
Only given if :attr:`type` is :attr:`WebhookType.channel_follower`.