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

Control the empty lines in the usage doc #256

Open
songtaogui opened this issue Sep 26, 2023 · 2 comments
Open

Control the empty lines in the usage doc #256

songtaogui opened this issue Sep 26, 2023 · 2 comments
Labels
display printing & display related issues enhancement New feature or request

Comments

@songtaogui
Copy link

The generated Usage contains many empty lines, I understand this may help for better layout when the usages are short. However, when the options gets complicated, the whole usage doc would become too long. Is there an option that I could control the empty lines?

for example, the generated usage of the Quick Start demo is:

  sum



Usage

  sum <args> [options] [flags]

Args

  <x>                                                       first number.

  <y>                                                       second number.



Options

  -p, --precision <type>                                    prescision of the calculation.



Flags

  -f, --fastmath                                            enable fastmath.

  -h, --help                                                Print this help message.
  --version                                                 Print version.

however, I prefer sth like:

  sum

Usage
  sum <args> [options] [flags]

Args
  <x>                                                       first number.
  <y>                                                       second number.

Options
  -p, --precision <type>                                    prescision of the calculation.

Flags
  -f, --fastmath                                            enable fastmath.

  -h, --help                                                Print this help message.
  --version                                                 Print version.

All the best!
Version of the package:

Status `~/.julia/environments/v1.9/Project.toml`
  [863f3e99] Comonicon v1.0.6
nothing
@songtaogui songtaogui added the bug Something isn't working label Sep 26, 2023
@songtaogui
Copy link
Author

sorry for automatically labeled this issue as [bug], it is more like a [request]. lol

@Roger-luo Roger-luo added enhancement New feature or request display printing & display related issues and removed bug Something isn't working labels Sep 27, 2023
@Roger-luo
Copy link
Collaborator

Yeah, this is because Comonicon was developed in pre-1.9 era, so we have to eliminate as much runtime as possible, resulting in non-adaptive printings. I believe in 1.9+ because of pkgimage, just doing dynamic printing can still have a reasonable latency. But I personally won't have much time working on this package this year. So any large changes will need to wait for next year after I graduate.

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

No branches or pull requests

2 participants