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

When are long_desc shown for switches or flags? #339

Open
rsanheim opened this issue Mar 7, 2025 · 1 comment
Open

When are long_desc shown for switches or flags? #339

rsanheim opened this issue Mar 7, 2025 · 1 comment

Comments

@rsanheim
Copy link

rsanheim commented Mar 7, 2025

I know that you can define long_desc for switches and flags like so:

  desc "Quiet mode: don't print anything, and don't auto-update"
  long_desc <<~LONG_DESC
    Quiet mode: don't print anything

    NOTE: this will override verbose mode, and also makes dry-run useless
  LONG_DESC
  switch %i[q quiet], default_value: false

In looking through the various help output code, I don't see where this the long_desc would ever get printed...in particular for global options.

I may just be missing it, or is this something that gli doesn't do currently?

@davetron5000
Copy link
Owner

The long_desc on commands shows up in the help for that command. long_desc for flags and switches only show up in the documentation produced via the _doc command all apps have, e.g. your_app _doc.

I couldn't figure out a decent way to show that in command-line help. If you have any ideas, I can look into it!

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