Skip to content

Commit 10af1ea

Browse files
authored
Document behavior for empty default permissions
1 parent a0dfdb9 commit 10af1ea

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

discord/app_commands/commands.py

+9
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,8 @@ class Command(Generic[GroupT, P, T]):
468468
default_permissions: Optional[:class:`~discord.Permissions`]
469469
The default permissions that can execute this command on Discord. Note
470470
that server administrators can override this value in the client.
471+
Setting an empty permissions field will disallow anyone except server
472+
administrators from using the command in a guild.
471473
472474
Due to a Discord limitation, this does not work on subcommands.
473475
guild_only: :class:`bool`
@@ -874,6 +876,8 @@ class ContextMenu:
874876
default_permissions: Optional[:class:`~discord.Permissions`]
875877
The default permissions that can execute this command on Discord. Note
876878
that server administrators can override this value in the client.
879+
Setting an empty permissions field will disallow anyone except server
880+
administrators from using the command in a guild.
877881
guild_only: :class:`bool`
878882
Whether the command should only be usable in guild contexts.
879883
Defaults to ``False``.
@@ -1025,6 +1029,8 @@ class shortened to 100 characters.
10251029
default_permissions: Optional[:class:`~discord.Permissions`]
10261030
The default permissions that can execute this group on Discord. Note
10271031
that server administrators can override this value in the client.
1032+
Setting an empty permissions field will disallow anyone except server
1033+
administrators from using the command in a guild.
10281034
10291035
Due to a Discord limitation, this does not work on subcommands.
10301036
guild_only: :class:`bool`
@@ -1828,6 +1834,9 @@ def default_permissions(**perms: bool) -> Callable[[T], T]:
18281834
However, an administrator can change the permissions needed to execute this command using the official
18291835
client. Therefore, this only serves as a hint.
18301836
1837+
Setting an empty permissions field, including via calling this with no arguments, will disallow anyone
1838+
except server administrators from using the command in a guild.
1839+
18311840
This is sent to Discord server side, and is not a :func:`check`. Therefore, error handlers are not called.
18321841
18331842
Due to a Discord limitation, this decorator does nothing in subcommands and is ignored.

0 commit comments

Comments
 (0)