commandlineparser / commandlineparser/commandline

Add short application description under name on all help screens

Open
#338 2 comments 5 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.8k
Forks
478
PR merge metrics
No merged PRs in 30d

Description

Currently if I type application name help screen does not contain any short description of application. If I use help on windows dir command:
```
`C:\Users\Example>dir /?
Displays a list of files and subdirectories in a directory.

...help text continues
```
I think that it's nice way of communicating for user, what this tool does (in few words).

Current output:
```
>MyApp.exe
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.
```

Would be nice output:
```
>MyApp.exe
MyApp 1.0.0
Utility for mass renaming files
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.
```

I think System.Reflection.AssemblyDescriptionAttribute would be good source of this description.

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.