search

za419 / CadenceBot

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

Separate help (summary) and help-for-topic #74

Closed za419 closed 3 years ago

za419 commented 3 years ago

This separates these two commands semantically from a code perspective, without doing so from a user perspective. I had originally intended to do this near the end of the project, but recent confusion surrounding the command has lead me to believe I should do otherwise.

This is the first new primary command added since March 17, 2019, in 319692aff356a5e1df5970a49923b7729a12290f.

Summary helptext with the new primary command: image

Detailed helptext for help, with helpTopic reconfigured to illustrate separation of commands: image

This PR fixes #67 .

JunhaoSLi commented 3 years ago

Is the "Cadence help me with help" logic getting added in this PR? I don't see it so wanted to ask.

za419 commented 3 years ago

Is the "Cadence help me with help" logic getting added in this PR? I don't see it so wanted to ask.

No, that is not new logic even - That is demonstrating that if reconfigured (commands.helpTopic = "Cadence help me with "), the bot will appropriately trigger and will fill in appropriately different prompt text in the helptext.

I don't hate the longer prompt, but I want to balance clarity and verbosity - "Cadence help admin" is much more concise, and therefore less annoying to type, than "Cadence help me with admin".