za419 / CadenceBot

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

Implement detailed helptext for each command #57

Closed za419 closed 3 years ago

za419 commented 3 years ago

Extend Cadence help to be able to take the name of a command and print helptext for it. Some thinking might need to happen to make the 'name' configurable enough.

This helptext should be a detailed, and full specification of how the command functions - ie search should describe special forms provided by the server.

Discussion is welcome over how, and indeed whether, automatically generated documentation of custom commands can be included in this (@kenellorando )

za419 commented 3 years ago

Detailed helptext for help is now done, as part of #58.

za419 commented 3 years ago

Commands that need documenting:

Non-command topics that need documenting for this issue to be considered resolved:

Non-command topics that need documenting, but not as part of this issue:

Any ideas for more?

magix430 commented 3 years ago

I would like to stake a claim on helptext for Play if it has not yet been claimed.

za419 commented 3 years ago

Play is all yours, @magix430

za419 commented 3 years ago

I am canceling this task in favor of more granular tasks for each PR and the project to track overall status.