commandline icon indicating copy to clipboard operation
commandline copied to clipboard

Extended help information

Open ShadowDancer opened this issue 6 years ago • 4 comments

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

ShadowDancer avatar Sep 26 '18 14:09 ShadowDancer

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

ericnewton76 avatar Dec 23 '18 21:12 ericnewton76

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

ShadowDancer avatar Dec 24 '18 00:12 ShadowDancer

Has this feature been implemented by now?

Siam1205 avatar Apr 25 '19 06:04 Siam1205

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

phaniva avatar May 28 '23 00:05 phaniva