diff --git a/src/System.CommandLine/Argument.cs b/src/System.CommandLine/Argument.cs index 1640e883df..f1c915045e 100644 --- a/src/System.CommandLine/Argument.cs +++ b/src/System.CommandLine/Argument.cs @@ -45,8 +45,21 @@ public ArgumentArity Arity } /// - /// The name used in help output to describe the argument. + /// Gets or sets the placeholder name shown in usage help for the argument's value. + /// The value will be wrapped in angle brackets (< and >). /// + /// + /// If null, the of the argument will be used. + /// + /// + /// An argument with of argument and a + /// of Value will be shown in usage help as: + /// <Value>. If is not set, + /// help output will show: <argument>. + /// + /// + /// The name to show as the placeholder for the argument's value. + /// public string? HelpName { get; set; } internal TryConvertArgument? ConvertArguments diff --git a/src/System.CommandLine/Parsing/SymbolResult.cs b/src/System.CommandLine/Parsing/SymbolResult.cs index 0016375754..18df4af83e 100644 --- a/src/System.CommandLine/Parsing/SymbolResult.cs +++ b/src/System.CommandLine/Parsing/SymbolResult.cs @@ -91,10 +91,13 @@ public IEnumerable Errors public DirectiveResult? GetResult(Directive directive) => SymbolResultTree.GetResult(directive); /// - /// Finds a result for a symbol having the specified name anywhere in the parse tree. + /// Finds a result for a having the specified anywhere in the parse tree. /// - /// The name of the symbol for which to find a result. - /// An argument result if the argument was matched by the parser or has a default value; otherwise, null. + /// The name of the for which to find a result. + /// + /// A if the was matched by the parser or has a default value; + /// otherwise, . + /// public SymbolResult? GetResult(string name) => SymbolResultTree.GetResult(name);