Add a way to view help and usage instrauctions of a specific command
LadyCailinBot opened this issue ยท 5 comments
WORLDEDIT-2947 - Reported by TheE
The enhancement I have in mind aims to improve the way a command's help and usage instructions can be accessed.
Currently, if a user wants to view the usage instructions and the longer help text of a specific command, he needs to enter an invalid version of this command (e.g. a non-existing flag) that is than catched by the commands manager and handled properly - which displays the needed usage instructions. Naturally this is quit complex since a user needs to remember a version of the command that does never work to look up informations about the same command.
The integration in the global help-menu is also not very helpful here, since it is only available for top-level commands and only includes the short command-describtion, not the longer help-text, not the usage instructions.
My idea would be to implement way to call usage and help that works the same way for any command (similar to --help for shell commands) that is handled in the commands-manager and, therefore, automatically available for all commands. The most straight-forward way might be a '?' flag (e.g. //schematic load -?).
Comment by TheE
Not usable for sub-commands.
Additionally this works for WorldEdit, but the whole purpose of the enhancement is to introduce a global way that works automatically for every command that uses WorldEdit's command system (/ban -?, /setwarp -?...).
Comment by SupaHam
I would definitely love to see this implemented. I've been using the Command Framework for a while and didn't want to implement my own.
Comment by TheE
Something I forgot to mention when writing this: The implementation I suggested would be fully backwards-compatible as commands cannot register '?' as a custom flag.
Comment by sk89q
{{//help}} supports sub-commands now and {{-?}} can be used on any command.
Screenshots: http://imgur.com/a/TMtHS