Skip to content
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

Add "help" option for each command #34

Open
Kardbord opened this issue Dec 2, 2021 · 4 comments
Open

Add "help" option for each command #34

Kardbord opened this issue Dec 2, 2021 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Kardbord
Copy link
Owner

Kardbord commented Dec 2, 2021

Despite how nicely slash commands are integrated with the Discord client, sometimes commands require more in depth explanation. Even for simple commands, it wouldn't hurt to have a more verbose help message. I think it would improve UX to have a help option come standard with each command.

@Kardbord Kardbord added the enhancement New feature or request label Dec 2, 2021
@Kardbord Kardbord self-assigned this Dec 2, 2021
@Kardbord Kardbord added the good first issue Good for newcomers label Dec 7, 2021
@Kardbord
Copy link
Owner Author

Kardbord commented Dec 7, 2021

Help messages should be ephemeral. See #35.

@Kardbord Kardbord assigned TnekRex and unassigned Kardbord Dec 30, 2021
@Kardbord
Copy link
Owner Author

Perhaps a better approach would be to have a /help command that takes another command as an argument?

@TnekRex
Copy link
Collaborator

TnekRex commented Jan 12, 2022 via email

@Kardbord
Copy link
Owner Author

The big downside to that approach is that Discord limits you to 25 subcommands. See the Options section of Application Command Structure. Subcommands are "options" of top level commands. It is likely that the bot will eventually have far more than 25 commands, if it doesn't already. To work around that limitation, we'll have to either have the user provide a command name as a raw string (no autocompletion), or take the approach of adding /help as a subcommand or boolean flag of each individual command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants