From 3a0bbc1e89a116822ae78e8096860fdcb85a42c0 Mon Sep 17 00:00:00 2001 From: Harrison Deng Date: Sun, 9 Dec 2018 01:09:50 -0600 Subject: [PATCH] improved documentation --- .../CommandProcessor/EngineCommand.cs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/RecrownedAthenaeum.ConsoleTools/CommandProcessor/EngineCommand.cs b/RecrownedAthenaeum.ConsoleTools/CommandProcessor/EngineCommand.cs index 2d20039..36bd44f 100644 --- a/RecrownedAthenaeum.ConsoleTools/CommandProcessor/EngineCommand.cs +++ b/RecrownedAthenaeum.ConsoleTools/CommandProcessor/EngineCommand.cs @@ -51,6 +51,8 @@ namespace RecrownedAthenaeum.Tools.CommandProcessor /// /// Returns the help for the given argument for this command. If no argument is defined, general help for the command should be given. /// If no argument is given (null), then returns overall help statement. + /// Overall help should list possible arguments for user to use "help [command] [arg]" format. + /// Arguments can then be separately returned from help as the help command will pass in the argument the user requests to see in detail in the parameter. /// /// The argument the help string is for. Can be null for overall command help. /// The text to help understand the argument.