Cog-Creators / Cog-Creators/Red-DiscordBot

Add `hidden_aliases` option for commands decorator

Open
#4,899 3 comments 2 reactions 0 assignees View on GitHub
Category: Core - API - Commands Package Status: Needs Discussion Type: Enhancement
Dominant language
Python
Stars
5.7k
Forks
2.5k
Avg merge
6d 16h
Merged PRs (30d)
1

Description

### 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:

```python
@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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.