Skip to content

Extended help information #337

@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

Activity

ericnewton76

ericnewton76 commented on Dec 23, 2018

@ericnewton76
Member

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

ShadowDancer

ShadowDancer commented on Dec 24, 2018

@ShadowDancer
Author

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

Siam1205

Siam1205 commented on Apr 25, 2019

@Siam1205

Has this feature been implemented by now?

phaniva

phaniva commented on May 28, 2023

@phaniva

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @ShadowDancer@phaniva@ericnewton76@Siam1205

        Issue actions

          Extended help information · Issue #337 · commandlineparser/commandline