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

[CLI] Improve object flag description #109

Open
AmadeusK525 opened this issue Aug 1, 2023 · 3 comments
Open

[CLI] Improve object flag description #109

AmadeusK525 opened this issue Aug 1, 2023 · 3 comments
Labels
cli cli related improvements enhancement New feature or request

Comments

@AmadeusK525
Copy link
Contributor

Flag descriptions have been implemented in #105, but objects should be handled differently. Maybe a ref value in the flag's description, with the full expanded object representation at the bottom of the help command, or something like that. Inline JSON representations are hard to grasp on a human level

@AmadeusK525 AmadeusK525 added the enhancement New feature or request label Aug 1, 2023
@barbieri barbieri added the cli cli related improvements label Aug 2, 2023
@barbieri
Copy link
Contributor

barbieri commented Dec 2, 2023

@AmadeusK525 fixed by #571?

@AmadeusK525
Copy link
Contributor Author

AmadeusK525 commented Dec 2, 2023

@AmadeusK525 fixed by #571?

Nah, #571 just makes the inline version work without bugs. For the (near?) future I'd like to have something like this:

Some description here

Flags
--some-flag   object Flag description here (#some-flag)

Global Flags
--global-flag string Flag description here

# some-flag
{
  "field": string,
  "other-field": {
    "data": [int]
  }
}

@barbieri
Copy link
Contributor

barbieri commented Dec 7, 2023

@AmadeusK525 take a look at the new repo, see if it's done, otherwise write what's missing

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

No branches or pull requests

2 participants