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

Improve structure/formatting of help output #604

Open
josh-berry opened this issue Jun 25, 2024 · 1 comment
Open

Improve structure/formatting of help output #604

josh-berry opened this issue Jun 25, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@josh-berry
Copy link
Collaborator

A few things I'd like to do to the output of --help to make it more readable (not sure if this should be one or multiple tickets):

  • Wrap output according to the user's terminal width
  • Re-order and clearly group output so it's: basic usage, long description, required flags, optional flags, generic/common flags
  • Properly-format Markdown output, and use the fancy new hyperlink extension that is supported by most modern terminals to link back to the web documentation
@dandavison
Copy link
Contributor

From #649: we could consider using the one-line summaries (text after ###) as the first sentence of the --help description of the command.

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

No branches or pull requests

2 participants