search

fisher60 / friendo-bot

A Discord Bot that is just a good Friendo
MIT License
25 stars 24 forks source link

make sure every command's help can allow a user to use that command with no other context #164

Open fisher60 opened 3 years ago

fisher60 commented 3 years ago

Summary

There is a big issue with the bot being documented, many commands are improperly documented.

I.e the flip command does not say anywhere that the command is .flip heads when doing .help fun, a user should be able to understand how to use each command in a cog by using .help <cog name>.

Implementation

Someone needs to go through all the cogs and the help command to ensure every command is usable from invoking .help <cog name>. This would mostly be by adding usage tips.

We could perhaps enhance the help command to include the usage attribute (if it does not already) and make usage mandatory for each command.

Ajay-Singh-Rana commented 3 years ago

I couldn't get what's the actual functionality you are asking for..?

fisher60 commented 3 years ago

@Ajay-Singh-Rana Hello, this issue is a bit larger and tedious. This is mostly a quality of life/user experience update.

Many help commands are not very clear and are missing some explanation of how to use the command. Some commands are also inconsistent, lacking important kwargs. This issue requires someone to go through all the available commands and ensure that a user could use the help command to understand all other commands, without needing any additional help.

I.e a user should be able to join the server and type any .help <command/cog> and be able to understand how to use this without being confused.