za419 / CadenceBot

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

Add detailed helptext for the nowplaying command #70

Closed za419 closed 3 years ago

za419 commented 3 years ago

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

Question: Should we add a mechanism to define an alias for help topics? That is, a way to config one helptext to act as if another had been used instead...

"helpTopics": {
    "nowplaying": {
        "internalKey": "nowplaying",
        "subtitle": ...,
        "lines": [...],
    },
    "now playing": {
        "alias": "nowplaying"
    }
}

And then "Cadence help now playing" automatically translates to "Cadence help nowplaying"?

Just a thought. If we agree this is a good idea, we can split that into another issue.

JunhaoSLi commented 3 years ago

In response to question, I don't think it's necessary. Reasoning is that someone without a cs background could probably understand why "Cadence help now playing" doesn't work because the actual command is "nowplaying". Still, I'm not against the feature (I guess I'm abstaining?).

za419 commented 3 years ago

The wrinkle is that the command, in default config, is in fact "Cadence now playing":

image

So there's a good argument to be made for why either is valid, and therefore for why both can be valid - That's my view at least.

za419 commented 3 years ago

Closed by #86