ClemBot icon indicating copy to clipboard operation
ClemBot copied to clipboard

Help Command Should State Cogs Responsible for Commands

Open Exper1mental opened this issue 4 years ago • 1 comments

Is your feature request related to a problem? Please describe.

When new folks are learning what cogs correspond to what commands, this can be rather challenging, especially since the help command no longer organized commands by the cog they're from.

Describe the solution you'd like

The help command when provided detailed info about a given command should have an entry stating the cog in which that command exists.

Example:

ClemBot - Help

!roles add

Description Command to add a role as assignable in the current guild

Signature [role]

Aliases create

Usage Example !roles add @SomeExampleRole

Parent Cog manage_classes_cog.py

Describe alternatives you've considered

Another command could be added, such as !source cog <command_here> that specifies the name and/or file path of the cog containing that command. Would be neat if it could also state the line where the command definition begins.

Exper1mental avatar Jan 23 '21 15:01 Exper1mental

I actually had it like that originally, the reason its left off is because the cog the command is in users dont need to know nor do they care. Its an implementation detail.

Jay-Madden avatar Jan 23 '21 22:01 Jay-Madden