commandlineparser / commandlineparser/commandline

Extended help information

Open
#337 4 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
C#
Stars
4.8k
Forks
478
PR merge metrics
No merged PRs in 30d

Description

I think that it would be nice if we could display additional text about application if someone types `MyApp --help`, and additional help for verb if someone types `MyApp Verb --help`.

I know there is `HelpText` property on `BaseAttribute`. It is nice for communicating what given option does, however I think that it is not suitable for extended, in-depth explanation. I would see it like that:

```
MyApp.exe help
MyApp 1.0.0
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.

Long explanation about app
```

```
MyApp.exe help verb1
MyApp 1.0.0
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.

Long explanation about verb1
```

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.