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

Add notes about contexts and installation_types availability

Browse Source
This commit is contained in:
Soheab 2024-05-31 04:51:51 +02:00 committed by GitHub
parent 2c197649c2
commit cc32fb364b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
discord/app_commands/commands.py
View File

@ -2372,6 +2372,12 @@ def guilds(*guild_ids: Union[Snowflake, int]) -> Callable[[T], T]:
with the :meth:`CommandTree.command` or :meth:`CommandTree.context_menu` decorator with the :meth:`CommandTree.command` or :meth:`CommandTree.context_menu` decorator
then this must go below that decorator. then this must go below that decorator.
.. note ::
Due to a Discord limitation, this decorator cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
Example: Example:
.. code-block:: python3 .. code-block:: python3

42
discord/app_commands/tree.py
View File

@ -307,10 +307,24 @@ class CommandTree(Generic[ClientT]):
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given or ``None`` then it The guild to add the command to. If not given or ``None`` then it
becomes a global command instead. becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
guilds: List[:class:`~discord.abc.Snowflake`] guilds: List[:class:`~discord.abc.Snowflake`]
The list of guilds to add the command to. This cannot be mixed The list of guilds to add the command to. This cannot be mixed
with the ``guild`` parameter. If no guilds are given at all with the ``guild`` parameter. If no guilds are given at all
then it becomes a global command instead. then it becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
override: :class:`bool` override: :class:`bool`
Whether to override a command with the same name. If ``False`` Whether to override a command with the same name. If ``False``
an exception is raised. Default is ``False``. an exception is raised. Default is ``False``.
@ -877,10 +891,24 @@ class CommandTree(Generic[ClientT]):
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given or ``None`` then it The guild to add the command to. If not given or ``None`` then it
becomes a global command instead. becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
guilds: List[:class:`~discord.abc.Snowflake`] guilds: List[:class:`~discord.abc.Snowflake`]
The list of guilds to add the command to. This cannot be mixed The list of guilds to add the command to. This cannot be mixed
with the ``guild`` parameter. If no guilds are given at all with the ``guild`` parameter. If no guilds are given at all
then it becomes a global command instead. then it becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
auto_locale_strings: :class:`bool` auto_locale_strings: :class:`bool`
If this is set to ``True``, then all translatable strings will implicitly If this is set to ``True``, then all translatable strings will implicitly
be wrapped into :class:`locale_str` rather than :class:`str`. This could be wrapped into :class:`locale_str` rather than :class:`str`. This could
@ -960,10 +988,24 @@ class CommandTree(Generic[ClientT]):
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given or ``None`` then it The guild to add the command to. If not given or ``None`` then it
becomes a global command instead. becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
guilds: List[:class:`~discord.abc.Snowflake`] guilds: List[:class:`~discord.abc.Snowflake`]
The list of guilds to add the command to. This cannot be mixed The list of guilds to add the command to. This cannot be mixed
with the ``guild`` parameter. If no guilds are given at all with the ``guild`` parameter. If no guilds are given at all
then it becomes a global command instead. then it becomes a global command instead.
.. note ::
Due to a Discord limitation, this keyword argument cannot be used in conjunction with
contexts (e.g. :func:`.app_commands.allowed_contexts`) or installation types
(e.g. :func:`.app_commands.allowed_installs`).
auto_locale_strings: :class:`bool` auto_locale_strings: :class:`bool`
If this is set to ``True``, then all translatable strings will implicitly If this is set to ``True``, then all translatable strings will implicitly
be wrapped into :class:`locale_str` rather than :class:`str`. This could be wrapped into :class:`locale_str` rather than :class:`str`. This could