-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: adds docstrings for some properties of InvokableSlashCommand
and SubCommand
and document Option
's attributes
#1112
Conversation
Yup, otherwise CI will continue to fail.
it's aliased to that, I honestly don't remember if there was a reason for it - @EQUENOS might know |
It's called |
InvokableSlashCommand
and SubCommand
InvokableSlashCommand
and SubCommand
and document Option's attributes
InvokableSlashCommand
and SubCommand
and document Option's attributesInvokableSlashCommand
and SubCommand
and document Option
's attributes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some minor nits - overall, this looks good to me
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Snipy7374 <[email protected]>
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Snipy7374 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
Signed-off-by: shiftinv <[email protected]>
Summary
Adds docstrings for the following properties:
.description
(added toInvokableSlashCommand
andSubCommand
).options
(added toInvokableSlashCommand
)additionally i feel like we should document some attributes of the
Option
class, the reference foSubCommand.description
(which isOption.description
) is already failing 'cause we're documenting only methods for theOption
classalso why the API representation is called and documented as
option
in this class? https://docs.disnake.dev/en/stable/ext/commands/api/app_commands.html#disnake.ext.commands.SubCommand.optionshouldn't it be called
body
(which already exists) like other slash command classes?Checklist
pdm lint
pdm pyright