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 usage + examples to help text #19

Open
lenscas opened this issue Sep 30, 2020 · 0 comments
Open

add usage + examples to help text #19

lenscas opened this issue Sep 30, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@lenscas
Copy link
Owner

lenscas commented Sep 30, 2020

Make it possible to show how to use a command as well as an example without manually putting it in the help text, so the help command can infer the rest. (Like how serenity does it)

lets take the prep_ban command for example. All I have to write is:

usage: {user},{amount_of_messages},
example @thanks_bot 10

and the output is:
Usage: prep_ban {user} {amount_of_messages}
Sample usage: prep_ban @thanks_bot 10

This will require changes in

  • src/help.ts to display this new data
  • src/command.ts to edit the command type to allow for this.
  • every command to give this new information (Can become its own issue later.)
@lenscas lenscas added the enhancement New feature or request label Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant