Skip to content

Commit

Permalink
Update docstrings for app command permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
tandemdude committed Feb 27, 2024
1 parent 13baaa9 commit be6a2d2
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions lightbulb/commands/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,10 @@ class SlashCommand(CommandBase, metaclass=CommandMeta, type=hikari.CommandType.S
description (:obj:`str`, required): The description of the command.
nsfw (:obj:`bool`, optional): Whether the command should be marked as nsfw. Defaults to :obj:`False`.
localizations (TODO, optional): Not yet implemented
dm_enabled (:obj:`bool`, optional): Whether the command can be used in direct messages. Defaults to :obj:`True`.
default_member_permissions (:obj:`hikari.Permissions`, optional): The default permissions required for a
guild member to use the command. If unspecified, all users can use the command by default. Set to
``hikari.Permissions.NONE`` to disable for everyone apart from admins.
hooks (:obj:`~typing.Sequence` [ :obj:`~lightbulb.commands.execution.ExecutionHook` ], optional): The hooks to
run before the command invocation function is executed. Defaults to an empty set.
Expand Down Expand Up @@ -390,6 +394,10 @@ class UserCommand(CommandBase, metaclass=CommandMeta, type=hikari.CommandType.US
name (:obj:`str`, required): The name of the command.
nsfw (:obj:`bool`, optional): Whether the command should be marked as nsfw. Defaults to :obj:`False`.
localizations (TODO, optional): Not yet implemented
dm_enabled (:obj:`bool`, optional): Whether the command can be used in direct messages. Defaults to :obj:`True`.
default_member_permissions (:obj:`hikari.Permissions`, optional): The default permissions required for a
guild member to use the command. If unspecified, all users can use the command by default. Set to
``hikari.Permissions.NONE`` to disable for everyone apart from admins.
hooks (:obj:`~typing.Sequence` [ :obj:`~lightbulb.commands.execution.ExecutionHook` ], optional): The hooks to
run before the command invocation function is executed. Defaults to an empty set.
Expand Down Expand Up @@ -425,6 +433,10 @@ class MessageCommand(CommandBase, metaclass=CommandMeta, type=hikari.CommandType
name (:obj:`str`, required): The name of the command.
nsfw (:obj:`bool`, optional): Whether the command should be marked as nsfw. Defaults to :obj:`False`.
localizations (TODO, optional): Not yet implemented
dm_enabled (:obj:`bool`, optional): Whether the command can be used in direct messages. Defaults to :obj:`True`.
default_member_permissions (:obj:`hikari.Permissions`, optional): The default permissions required for a
guild member to use the command. If unspecified, all users can use the command by default. Set to
``hikari.Permissions.NONE`` to disable for everyone apart from admins.
hooks (:obj:`~typing.Sequence` [ :obj:`~lightbulb.commands.execution.ExecutionHook` ], optional): The hooks to
run before the command invocation function is executed. Defaults to an empty set.
Expand Down

0 comments on commit be6a2d2

Please sign in to comment.