commandlineparser / commandlineparser/commandline

SetName specific help text

Open
#870 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
C#
Stars
4.8k
Forks
478
PR merge metrics
No merged PRs in 30d

Description

Propose a smarter help text when SetName exists, prefer separated help text based on SetName, because the current help text doesn't tell users options in different SetNames are exclusive.

we could have help text as below:

**web** command:

--documentroot

--enablejavascript

-r

--help Display this help screen.

--version Display version information.

**ftp** command:

--ftpdirectory

--anonymouslogin

-r

--help Display this help screen.

--version Display version information.

Example option:

public class OptionsMutuallyExclusive
{
//Implement commands in set(group) named web
[Option(SetName = "web")]
public string DocumentRoot
{
get;
set;
}

[Option(SetName = "web")]
public bool EnableJavaScript
{
get;
set;
}

//Implement other commands in set(group) named ftp
[Option(SetName = "ftp")]
public string FtpDirectory
{
get;
set;
}

[Option(SetName = "ftp")]
public bool AnonymousLogin
{
get;
set;
}

//Common option, can be used with any set because it's not included in a set
[Option('r')]
public string UrlAddress
{
get;
set;
}
}

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.