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

Clarify documentation certain tree methods

Browse Source
This commit is contained in:
Rapptz 2022-03-31 10:31:43 -04:00
parent 2010b42f6a
commit a0618ef791
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
discord/app_commands/tree.py
View File

@ -245,7 +245,7 @@ class CommandTree(Generic[ClientT]):
command: Union[:class:`Command`, :class:`Group`] command: Union[:class:`Command`, :class:`Group`]
The application command or group to add. The application command or group to add.
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given 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.
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
@ -381,7 +381,7 @@ class CommandTree(Generic[ClientT]):
command: :class:`str` command: :class:`str`
The name of the root command to remove. The name of the root command to remove.
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to remove the command from. If not given then it The guild to remove the command from. If not given or ``None`` then it
removes a global command instead. removes a global command instead.
type: :class:`~discord.AppCommandType` type: :class:`~discord.AppCommandType`
The type of command to remove. Defaults to :attr:`~discord.AppCommandType.chat_input`, The type of command to remove. Defaults to :attr:`~discord.AppCommandType.chat_input`,
@ -457,7 +457,7 @@ class CommandTree(Generic[ClientT]):
command: :class:`str` command: :class:`str`
The name of the root command to get. The name of the root command to get.
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to get the command from. If not given then it The guild to get the command from. If not given or ``None`` then it
gets a global command instead. gets a global command instead.
type: :class:`~discord.AppCommandType` type: :class:`~discord.AppCommandType`
The type of command to get. Defaults to :attr:`~discord.AppCommandType.chat_input`, The type of command to get. Defaults to :attr:`~discord.AppCommandType.chat_input`,
@ -523,8 +523,8 @@ class CommandTree(Generic[ClientT]):
Parameters Parameters
----------- -----------
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to get the commands from. If not given then it The guild to get the commands from, not including global commands.
gets all global commands instead. If not given or ``None`` then only global commands are returned.
type: :class:`~discord.AppCommandType` type: :class:`~discord.AppCommandType`
The type of commands to get. Defaults to :attr:`~discord.AppCommandType.chat_input`, The type of commands to get. Defaults to :attr:`~discord.AppCommandType.chat_input`,
i.e. slash commands. i.e. slash commands.
@ -588,8 +588,8 @@ class CommandTree(Generic[ClientT]):
Parameters Parameters
----------- -----------
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to iterate the commands from. If not given then it The guild to iterate the commands from, not including global commands.
iterates all global commands instead. If not given or ``None`` then only global commands are iterated.
type: :class:`~discord.AppCommandType` type: :class:`~discord.AppCommandType`
The type of commands to iterate over. Defaults to :attr:`~discord.AppCommandType.chat_input`, The type of commands to iterate over. Defaults to :attr:`~discord.AppCommandType.chat_input`,
i.e. slash commands. i.e. slash commands.
@ -751,7 +751,7 @@ class CommandTree(Generic[ClientT]):
the application command. If not given, it defaults to the first line of the docstring the application command. If not given, it defaults to the first line of the docstring
of the callback shortened to 100 characters. of the callback shortened to 100 characters.
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given 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.
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
@ -815,7 +815,7 @@ class CommandTree(Generic[ClientT]):
version of the callback name. Note that unlike regular slash commands this can version of the callback name. Note that unlike regular slash commands this can
have spaces and upper case characters in the name. have spaces and upper case characters in the name.
guild: Optional[:class:`~discord.abc.Snowflake`] guild: Optional[:class:`~discord.abc.Snowflake`]
The guild to add the command to. If not given 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.
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