Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extended help information #337

Open
ShadowDancer opened this issue Sep 26, 2018 · 4 comments
Open

Extended help information #337

ShadowDancer opened this issue Sep 26, 2018 · 4 comments

Comments

@ShadowDancer
Copy link

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
@ericnewton76
Copy link
Member

The enhancement could allow for "pre-options-summary-text" and "post-options-summary-text" blocks

@ShadowDancer
Copy link
Author

I'd be happy to contribute if You could guide me a bit!

@Siam1205
Copy link

Has this feature been implemented by now?

@phaniva
Copy link

phaniva commented May 28, 2023

Does this issue still need to be open? It looks like AddPreOptionLines and AddPostOptionLines on HelpText solve this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants