CmdHelp: Added guidance notes

This commit is contained in:
Paul Beckingham 2016-03-19 12:58:04 -04:00
parent 97720e4061
commit 0078eadf37

View file

@ -49,7 +49,11 @@ int CmdHelpUsage ()
// maps to the the appropriate ones. Then display a list of any ambiguous
// requests, or the appropriate doc for single hits. Perhaps a 'See also'.
//
// TODO Should the CmdXxx functions themselves be responsible for providing both
// the command syntax and the help text?
//
// Strict 80-character limit.
// Provide examples where appropriate - enough to cover all uses.
int CmdHelp (const std::vector <std::string>& args, Log& log)
{
if (args.size () > 2)