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

usage and description display order #1234

Closed
tdjastrzebski opened this issue Mar 30, 2020 · 2 comments
Closed

usage and description display order #1234

tdjastrzebski opened this issue Mar 30, 2020 · 2 comments

Comments

@tdjastrzebski
Copy link

Although it makes perfect sense to display usage and then description on command help, it may make more sense to display description first and then usage on program help. Otherwise default help output looks like:

Usage: MyProgram MyCommand

MyProgram is a super demo program (description)

Options:
--version
--myoption, -m   demo option

Desired order:

MyProgram is a super demo program (description)

Usage: MyProgram MyCommand

Options:
--version
--myoption, -m   demo option
@shadowspawn
Copy link
Collaborator

I do not think we are likely to make this change on its own. I have collected help related issues into #1225, and added this. One way of achieving what you suggest might be with a "prefix/banner" which has come up a few times.

@shadowspawn
Copy link
Collaborator

No further activity in a month. Added to #1225. Closing as (partially) covered by that collection.

Thank you for your contributions.

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

No branches or pull requests

2 participants