NUbots / robocup

The NUbot's RoboCup Code
GNU General Public License v3.0
34 stars 17 forks source link

Update the Script Tuner's `help` command. #69

Closed mmetcalfe closed 8 years ago

mmetcalfe commented 11 years ago

Typing help within the script tuner is supposed to print a brief summary of available commands. The current help output isn't very helpful. It should be updated to include a complete command summary (minimally, just command names and parameters - but preferably also a brief description of each command).

Consider implementing a help and a longhelp command (or similar) to show just the command list, or the full list of descriptions.

Also consider: Currently, there is no consequence for not adding new commands to the help printout, and it's easy to forget. If it's not too big a change, it would be nice to report on this during runtime. (e.g. at startup, or whenever a command is issued, report an error if any command name is not a substring of the entire help output.)