search

Cog-Creators / Red-DiscordBot

A multi-function Discord bot
https://docs.discord.red
GNU General Public License v3.0
4.84k stars 2.31k forks source link

Add `hidden_aliases` option for commands decorator #4899

Open RheingoldRiver opened 3 years ago

RheingoldRiver commented 3 years ago

What component of Red (cog, command, API) would you like to see improvements on?

API

Describe the enhancement you're suggesting.

Sometimes, we have a lot of aliases of a command in case someone forgets if it ends in an s or not, or how to spell something, etc. But it super clutters up the help to print every single alias. I would like to propose the following modification to the @commands.command decorator:

@commands.command(aliases=['awakenings'], hidden_aliases=['awakening', 'awakening_help', 'awake_help', 'awoken_help', 'awokens_help'])

The hidden aliases would function identically to aliases but NOT be printed in the command documentation.

Flame442 commented 3 years ago

As a potential workaround, you can disable [p]helpset showaliases if you don't want help to be cluttered, but this will prevent any aliases from being shown.

RheingoldRiver commented 3 years ago

Oh, thanks so much! That's a huge improvement for us! We had been deleting a lot of our aliases to de-clutter this screen, but instead we'll just disable (at least for now)! I'll still leave this issue open, since being able to choose a few aliases to show would be wonderful, but that helps us a ton!