Skip to content

Extended help information #337

Open
Open
@ShadowDancer

Description

@ShadowDancer

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions