Increased Clarity For Help Command Signatures

Swiddis / word-debt-bot

A Discord bot for running a little reading game.

MIT License

2 stars 2 forks source link

Increased Clarity For Help Command Signatures #40

Open mistcurve opened 5 months ago

mistcurve commented 5 months ago

Currently after calling .help log the signature at the top is displayed as

.log

My suggestion is to include function arguments in brackets to indicate order of the arguments, or otherwise clarifying the format if tagged arguments are added

.log [words] [genre]

Swiddis commented 5 months ago

This might need a custom help command, I'm not sure if this is configurable within the default discord.py help setup. I also was wrestling a bit with the help for args under buy to see if I could make it more useful but haven't had much luck, so this isn't the only issue with the default help either.