za419 / CadenceBot

A Discord bot for Cadence Radio
MIT License
2 stars 1 forks source link

Add detailed helptext for the search command #71

Open za419 opened 3 years ago

za419 commented 3 years ago

Add an entry into default-config.json under helpTopics. The key should probably be 'search', and the description should describe how one can use the command and how it will behave from a user perspective.

This will probably be the most complex helptext, and indeed this is the command which prompted me to give into the need for detailed helptext to begin with.

As part of covering how to behave, this needs to cover what forms of search are possible, which requires knowledge pulled from Cadence Radio itself. As I have implemented this search system twice personally and have experience reading the Cadence server code (certainly moreso than any other active CadenceBot developer, as @kenellorando's one-line change to the play command's output doesn't qualify him as active after this long), I will handle this myself.